👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to kt-guava. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
This project and everyone participating in it is governed by kt-guava's Code of Conduct. By participating, you are expected to uphold this code.
This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.
Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.
Note: If you find a closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
- Perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.
Bugs are tracked as GitHub issues. Create an issue and provide the following information by filling in the template.
Explain the problem and include additional details to help maintainers reproduce the problem:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible. When listing steps, don't just say what you did, but explain how you did it.
- Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.
- If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.
Provide more context by answering these questions:
- Did the problem start happening recently (e.g. after updating to a new version) or was this always a problem?
- If the problem started happening recently, what's the most recent version in which the problem doesn't happen?
- Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
Include details about your configuration and environment:
- Which version of kt-guava are you using?
This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.
Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible. Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.
- Perform a cursory search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
Enhancement suggestions are tracked as GitHub issues. Create an issue on that repository and provide the following information:
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
- Explain why this enhancement would be useful to most users.
- Specify which version of kt-guava you're using.
Unsure where to begin contributing? You can start by looking through these beginner and help-wanted issues:
- [Beginner issues][good first issue] - issues which should only require a few lines of code
- [Help wanted issues][help wanted] - issues which should be a bit more involved than
beginnerissues.
- Fill in the required template
- Title the pull request [issue number][description]
- For example,
Issue #0: Add a readme file - End all files with a newline
- Follow the style guide
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Title the commit message [issue number][message]
- For example,
Issue #0: Initial commit adding a readme file
- For example,
- Place additional information after the first line
- This project uses Git flow. If you are not familiar, look here: http://nvie.com/posts/a-successful-git-branching-model/
- If Git flow looks difficult or confusing, you can download GitKraken and it will handle branching/merging for you (tutorial here).
- Name a new branch according to its purpose in the format: [issue/bug/feature]/[your initials]/[issue number][description]
- For example, to make a branch to fix Issue #0 about adding a README file, name the branch
issue/ABC/#0_add_readme_file
- For example, to make a branch to fix Issue #0 about adding a README file, name the branch
By contributing to kt-guava, you agree that your code will be distributed with kt-guava, and licensed under the license for the kt-guava project. You should not contribute code that you do not have permission to relicense in this manner. Our license is the Mozilla Public License 2.0, which you can find here.
(This licensing clause adapted from the WPIlib clause here)