First off, thanks for taking the time to contribute!
The following is a set of mostly guidelines, not rules for contributing to Slack Gardener. Use your best judgment, and feel free to propose changes to this document in a pull request.
This section guides you through submitting a bug report for Slack Gardener. 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. 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. For example, start by explaining the execution environment Slack Gardener is working in, e.g. AWS Lambda/GCP Functions/Running Locally. When listing steps, don't just say what you did, but explain how you did it. For example, if started locally, was it via running a jar on the command line? in debug mode of IntelliJ?
- 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 you're reporting that Slack Gardener crashed, include logs, and if possible a stack trace. Include the logs in the issue in a code block, a file attachment, or put it in a gist and provide link to that gist.
- If the problem is related to performance or memory, include how to reproduce in detail, as well as any tests that can reproduce the issue.
Provide more context by answering these questions:
- Did the problem start happening recently (e.g. after updating to a new version of Slack Gardener) or was this always a problem?
- If the problem started happening recently, can you reproduce the problem in an older version of Slack Gardener? What's the most recent version in which the problem doesn't happen? You can compile older git hashes of Slack Gardener from this repo, Git Bisect is useful for this.
- 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 Slack Gardener are you using? Git hashes are preferred, but jar artifacts are also helpful if available
- What's execution environment your running the Slack Gardener in?
- What configs are you using with the Slack Gardener (please don't include slack access tokens)? Provide the contents of those configs, preferably in a code block or with a link to a gist.
This section guides you through submitting an enhancement suggestion for Slack Gardener, 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.
- 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.
- Describe the current behavior and explain which behavior you expected to see instead and why.
- Explain why this enhancement would be useful to most Slack Gardeners installations.
- Specify which version of Slack Gardener you're using. Git hashes are preferred
- Specify the execution environment you're using.
Slack Gardener can be developed locally. Instructions on how to setup this up are:
-
Pull down the repo
-
Run the below on the command line to pull down the necessary dependencies and setup the idea files
./gradlew clean build test idea -
Import into IntelliJ Idea, via normal import process
The process described here has several goals:
- Maintain and improve Slack Gardener's quality
- Fix problems that are important to users
- Engage the community in working toward the best possible Slack Gardener
- Enable a sustainable system for Slack Gardener's maintainers to review contributions
Please follow these steps to have your contribution considered by the maintainers:
- Follow all instructions in the template
- Follow the styleguides
- After you submit your pull request, verify that all status checks are passing
What if the status checks are failing?
If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Reference issues and pull requests liberally after the first line
- Slack Gardener currently uses IntelliJ IDEA's default kotlin styleguide
- Use Markdown.