chore: Add OSS guidelines

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,30 @@
+# Code of Conduct
+
+This Code of Conduct outlines our expectations for participants within the Rocketseat community as well as steps to reporting unacceptable behavior. Our goal is to make explicit what we expect from participants in this community as well as its leaders. We are committed to providing a welcoming and inspiring community for all and expect our code of conduct to be honored. Anyone who violates this code of conduct may be banned from the community.
+
+Our community strives to:
+
+- **Be welcoming, friendly and patient**.
+- **Be considerate**: Your work will be used by other people, and you in turn will depend on the work of others. Any decision you take will affect users and colleagues, and you should take those consequences into account when making decisions. Remember that you might not be communicating in someone else’s primary language.
+- **Be respectful**: Not all of us will agree all the time, but disagreement is no excuse for poor behavior and poor manners. We might all experience some frustration now and then, but we cannot allow that frustration to turn into a personal attack. It’s important to remember that a community where people feel uncomfortable or threatened is not a productive one.
+- **Be understandable**: Disagreements, both social and technical, happen all the time and Rocketseat is no exception. It is important that we resolve disagreements and differing views constructively. Remember that we're different. The strength of Rocketseat comes from its varied community, people from a wide range of backgrounds. Different people have different perspectives on issues. Being unable to understand why someone holds a viewpoint doesn't mean that they're wrong. Don't forget that it is human to err and blaming each other doesn't get us anywhere, rather offer to help resolving issues and to help learn from mistakes.
+
+This code serves to distill our common understanding of a collaborative, shared environment, and goals. We expect it to be followed in spirit as much as in the letter.
+
+### Diversity Statement
+
+We encourage everyone to participate and are committed to building a community for all. Although we may not be able to satisfy everyone, we all agree that everyone is equal. Whenever a participant has made a mistake, we expect them to take responsibility for it. If someone has been harmed or offended, it is our responsibility to listen carefully and respectfully, and do our best to right the wrong.
+
+Although this list cannot be exhaustive, we explicitly honor diversity in age, gender, gender identity or expression, culture, ethnicity, language, national origin, political beliefs, profession, race, religion, sexual orientation, socioeconomic status, and technical ability. We will not tolerate discrimination based on any of the protected characteristics above, including participants with disabilities.
+
+### Reporting Issues
+
+If you experience or witness unacceptable behavior—or have any other concerns—please report it by contacting us via [[email protected]](mailto:[email protected]). All reports will be handled with discretion. In your report please include:
+
+- Your contact information.
+- Names (real, nicknames, or pseudonyms) of any individuals involved. If there are additional witnesses, please include them as well. Your account of what occurred, and if you believe the incident is ongoing. If there is a publicly available record, please include a link.
+- Any additional information that may be helpful.
+
+After filing a report, a representative will contact you personally. If the person who is harassing you is part of the response team, they will recuse themselves from handling your incident. A representative will then review the incident, follow up with any additional questions, and make a decision as to how to respond. We will respect confidentiality requests for the purpose of protecting victims of abuse.
+
+Anyone asked to stop unacceptable behavior is expected to comply immediately. If an individual engages in unacceptable behavior, the representative may take any action they deem appropriate, up to and including a permanent ban from our community without warning.

.github/CONTRIBUTING.md

@@ -0,0 +1,180 @@
+# Contribution guidelines
+
+## Table of Contents
+
+- [Getting started](#getting-started)
+  - [Language](#language)
+    - [For native English speakers](#for-native-english-speakers)
+  - [Code of Conduct](#code-of-conduct)
+- [How can I help?](#how-can-i-help)
+  - [Documentation](#documentation)
+  - [Issues](#issues)
+    - [Submitting an issue](#submitting-an-issue)
+  - [Feedback](#feedback)
+  - [Code](#code)
+- [Commiting](#commiting)
+  - [Why all these rules?](#why-all-these-rules)
+- [Submitting a pull request](#submitting-a-pull-request)
+
+## Getting started
+
+First off, we would like to thank you for taking the time to contribute and make this a better project!
+
+Here we have a set of instructions and guidelines to reduce misunderstandings and make the process of contributing to `adonis-bull` as smooth as possible. We hope this guide makes the contribution process clear and answers any questions you may have.
+
+### Language
+
+Please, while contributing or interacting in any way in this project, **refrain from using any language other than English**.
+
+#### For native English speakers
+
+Try to use simple words and sentences. Don't make fun of non-native English speakers if you find something wrong about the way they express themselves.
+
+Try to encourage newcomers to express their opinions, and make them comfortable enough to do so.
+
+### Code of Conduct
+
+We expect that project participants to adhere to our Code of Conduct. You can check the [full text](CODE_OF_CONDUCT.md) so that you may understand the kind of conduct we are expecting and what actions will and will not be tolerated.
+
+By participating in this project, you agree to abide by its terms.
+
+## How can I help?
+
+Here are some ways you can help along with some guidelines.
+
+### Documentation
+
+As a user of `adonis-bull`, you're the perfect candidate to help us improve our documentation!
+
+Typos, errors, lack of examples and/or explanation and so on, are just some examples of things that could be fixed and/or improved. You could even make improvements to this guide :)
+
+While documenting, try to keep things simple and clear.
+
+### Issues
+
+Some issues are created with missing information, without a template, not reproducible, or plain
+invalid. You can make them easier to understand and resolve.
+
+#### Submitting an issue
+
+- Please search for similar issues before opening a new one;
+- Use one of the corresponding issue templates;
+- Use a clear and descriptive title;
+- Include as much information as possible by filling out the provided issue template;
+- Most of the time, the best way to report an issue is a failing test proving it.
+
+### Feedback
+
+The more feedback the better! We're always looking for more suggestions and opinions on discussions. That's a good opportunity to influence the future direction of this tool.
+
+This includes submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality.
+
+The [`question`](https://github.com/Rocketseat/adonis-bull/labels/type%3A%20question%20or%20discussion)and [`rfc`](https://github.com/Rocketseat/adonis-bull/labels/type%3A%20rfc) labels are a good place to find ongoing discussions.
+
+### Code
+
+You can use issue labels to discover issues you could help out with:
+
+- [`bug` issues](https://github.com/Rocketseat/adonis-bull/labels/kind%3A%20bug) are known bugs we'd like to fix;
+- [`enhancement` issues](https://github.com/Rocketseat/adonis-bull/labels/type%3A%20feature%20request) are features we're open to include.
+
+The [`help wanted`](https://github.com/Rocketseat/adonis-bull/labels/help%20wanted) and [`good first issue`](https://github.com/Rocketseat/adonis-bull/labels/good%20first%20issue) labels are especially useful.
+
+When you see an issue that is already assigned, please check to see if there isn't someone working on it already (maybe try asking in the issue). This is to prevent unnecessary work for everyone involved.
+
+## Commiting
+
+A commit message can consists of a **header**, **body** and **footer**. The header is the only mandatory part and consists of a type and a subject. The body is used to fully describe the change. The footer is the place to reference any issues or pull requests related to the commit. That said, we end with a template like this:
+
+```
+<type>: <subject>
+
+[optional body]
+
+[optional footer]
+```
+
+To ensure that a commit is valid, easy to read, and changelog-ready, we have a hook that lints the commit message before allowing a commit to pass. This linter verifies the following:
+
+- The header (first line) is the only mandatory part of the commit message;
+- The body and footer are both optional but its use is highly encouraged;
+- The header should contains:
+  - A type:
+    - Must be lowercase;
+    - Must be one of:
+      - **chore**: A change that neither fix a bug nor adds a feature;
+      - **ci**: A CI change;
+      - **docs**: A documentation change or fix;
+      - **feat**: A new feature;
+      - **fix**: A bug fix;
+      - **test**: A test-related change.
+      - **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+  - A subject:
+    - Must be capitalized;
+    - Must be limited to 50 characters or less;
+    - Must omit any trailing punctuation.
+- The body:
+  - Must have a leading blank line;
+  - Each line must be limited to 72 characters or less.
+- The footer:
+  - Must have a leading blank line;
+  - Each line must be limited to 72 characters or less;
+  - If your commit is about documentation or meta files, please add the tag **[skip ci]** to skip the building process.
+  - If needed, reference to issues and pull requests must be made here in the last line.
+
+You also should follow these general guidelines when committing:
+
+- Use the present tense ("Add feature" not "Added feature");
+- Use the imperative mood ("Move cursor to..." not "Moves cursor to...");
+- Try to answer the following questions:
+  - Why is this change necessary?
+  - How does it address the issue?
+  - What side effects (if any) does this change may have?
+
+Example of a commit message:
+
+```
+type: Commit message style guide for Git
+
+The first line of a commit message serves as a summary.  When displayed
+on the web, it's often styled as a heading, and in emails, it's
+typically used as the subject. As such, you should specify a "type" and
+a "subject". The type must be lowercase and one of: chore, ci, docs,
+feat, fix, test. For the subject you'll need capitalize it and
+omit any trailing punctuation. Aim for about 50 characters, give or
+take, otherwise it may be painfully truncated in some contexts. Write
+it, along with the rest of your message, in the present tense and
+imperative mood: "Fix bug" and not "Fixed bug" or "Fixes bug".
+Consistent wording makes it easier to mentally process a list of
+commits.
+
+Oftentimes a subject by itself is sufficient. When it's not, add a
+blank line (this is important) followed by one or more paragraphs hard
+wrapped to 72 characters. Git is strongly opinionated that the author
+is responsible for line breaks; if you omit them, command line tooling
+will show it as one extremely long unwrapped line. Fortunately, most
+text editors are capable of automating this.
+
+Issues and pull request can be referenced on the footer: #3 #12
+```
+
+### Why all these rules?
+
+We try to enforce these rules for the following reasons:
+
+- Automatically generating changelog;
+- Communicating in a better way the nature of changes;
+- Triggering build and publish processes;
+- Automatically determining a semantic version bump (based on the types of commits);
+- Making it easier for people to contribute, by allowing them to explore a more structured commit history.
+
+## Submitting a pull request
+
+Before submitting a pull request, please make sure the following is done:
+
+- [Fork](https://help.github.com/en/articles/fork-a-repo) the repository and create your branch from `master`.
+  - Example: `feat/my-awesome-feature` or `fix/annoying-bug`;
+- Run `yarn` in the repository root;
+- If you’ve fixed a bug or added code that should be tested, **add tests**;
+- Ensure the test suite passes;
+- Ensure your commit is validated;

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Rocketseat
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -238,3 +238,19 @@ class QueueHandler {
 
 module.exports = QueueHandler;
 ```
+
+## Contributing
+
+Thank you for being interested in making this package better. We encourage everyone to help improve this project with new features, bug fixes, or performance improvements. Please take a little bit of your time to read our guide to make this process faster and easier.
+
+### Contribution Guidelines
+
+To understand how to submit an issue, commit and create pull requests, check our [Contribution Guidelines](/.github/CONTRIBUTING.md).
+
+### Code of Conduct
+
+We expect you to follow our [Code of Conduct](/.github/CODE_OF_CONDUCT.md). You can read it to understand what kind of behavior will and will not be tolerated.
+
+## License
+
+MIT License © [Rocketseat](https://github.com/Rocketseat)