👍🎉 First off, thanks for taking the time to contribute! 🎉👍
These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
What should I know before I get started?
This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
This projects adheres to the MIT license. By participating, you are expected to license your contributions within the same license and you are allowed to make your contributions under this license.
This section guides you through submitting a bug report for Atom. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.
Before creating bug reports, please do a search 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.
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. For example, start by explaining how you started Atom, e.g. which command exactly you used in the terminal, or how you started Atom otherwise. When listing steps, don't just say what you did, but explain how you did it. For example, if you moved the cursor to the end of a line, explain if you used the mouse, or a keyboard shortcut or an Atom command, and if so which one?
- 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 of the role) or was this always a problem?
- If the problem started happening recently, can you reproduce the problem in an older version of the role? What's the most recent version in which the problem doesn't happen? You can download older versions of the role with
ansible-galaxy. - 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:
- What's the name and version of the OS you're using?
This section guides you through submitting an enhancement suggestion for the role, 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 do a search 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.
Enhancement suggestions are tracked as GitHub issues. Create an issue on the 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.
- Describe the current behavior and explain which behavior you expected to see instead and why.
- Explain why this enhancement would be useful to most the roles users.
- Specify which version of the role you're using.
- Specify the name and version of the OS you're using.
Unsure where to begin contributing to Atom? You can start by looking through these beginner and help-wanted issues:
- Easy picl issues - issues which should only require a few lines of code, and a test or two.
- Help wanted issues - issues which should be a bit more involved than
beginnerissues.
Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.
- Fill in the required template
- Follow the Ansible styleguide.
- Include well-structured tests
./testsfolder. - End files with a newline.
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally
- When only changing documentation, include
[ci skip]in the commit description - Consider starting the commit message with an applicable emoji:
- 🎨
:art:when improving the format/structure of the code - 🐎
:racehorse:when improving performance - 📝
:memo:when writing docs - 🐛
:bug:when fixing a bug - 🔥
:fire:when removing code or files - 💚
:green_heart:when fixing the CI build - ✅
:white_check_mark:when adding tests - 🔒
:lock:when dealing with security - ⬆️
:arrow_up:when upgrading dependencies - ⬇️
:arrow_down:when downgrading dependencies - 👕
:shirt:when removing linter warnings
- 🎨
- YAML files - All yaml files should use 2 space indents and end with
.yml - Variables - Use jinja variable syntax over deprecated variable syntax.
{{ var }}not$var - Use spaces around jinja variable names.
{{ var }}not{{var}} - Prefix all variables defined in a role with the name of the role. Example:
platformsh_ - Keep the role self contained - Roles should avoid including tasks from other roles when possible
- Separators - Use underscores (e.g.
my_var) not dashes (my-var). - Paths - When defining paths, do not include trailing slashes (e.g.
my_path: /foonotmy_path: /foo/. When concatenating paths, follow the same convention (e.g.{{ my_path }}/barnot{{ my_path }}bar) - Follow the Ansible best practices for writing tasks
This section lists the labels we use to help us track and manage issues and pull requests.
GitHub search makes it easy to use labels for finding groups of issues or pull requests you're interested in.
The labels are loosely grouped by their purpose, but it's not required that every issue have a label from every group or that an issue can't have more than one label from the same group.
Please open an issue if you have suggestions for new labels, and if you notice some labels are missing, then please open an issue too.
| Label name | 🔎 | Description |
|---|---|---|
feature |
search | Feature requests. |
enhancement |
search | Improvement requests. |
optimization |
search | Optimization requests, e.g. performance, better syntax, etc. |
bug |
search | Confirmed bugs or reports that are very likely to be bugs. |
question |
search | Questions more than bug reports or feature requests (e.g. how do I do X). |
feedback |
search | General feedback more than bug reports or feature requests. |
help wanted |
search | The Atom core team would appreciate help from the community in resolving these issues. |
easy pick |
search | Less complex issues which would be good first issues to work on for users who want to contribute. |
more information needed |
search | More information needs to be collected about these problems or feature requests (e.g. steps to reproduce). |
needs reproduction |
search | Likely bugs, but haven't been reliably reproduced. |
backlog |
search | Issues which are are planned to start work on. |
in progress |
search | Issues which are currently worked on. |
blocked |
search | Issues blocked on other issues. |
duplicate |
search | Issues which are duplicates of other issues, i.e. they have been reported before. |
wontfix |
search | The core team has decided not to fix these issues for now, either because they're working as intended or for some other reason. |
invalid |
search | Issues which aren't valid (e.g. user errors). |
| Label name | 🔎 | Description |
|---|---|---|
ubuntu |
search | Related to provisioning Ubuntu. |
debian |
search | Related to provisioning Debian. |
docs |
search | Related to any type of documentation. |
security |
search | Related to security. |
| Label name | 🔎 | Description |
|---|---|---|
in progress |
search | Pull requests which are still being worked on, more changes will follow. |
needs review |
search | Pull requests which need code review, and approval from maintainers or core team. |
under review |
search | Pull requests being reviewed by maintainers or core team. |
requires changes |
search | Pull requests which need to be updated based on review comments and then reviewed again. |
needs testing |
search | Pull requests which need manual testing. |