CONTRIBUTE.md

Contributing

👍🎉 First off all, thanks for taking the time to contribute! 🎉👍

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

How can I Contribute?

Reporting Bugs

Bugs are tracker as GitHub issues. Explain the problem and include additional details to help maintainers reproduce the proble:

• 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 the project, e.g. which command exactly you used in the terminal, or how you started the project otherwise.
• Provide specific examples to demonstrate the steps. Include links to files, or copy/paste 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.
• Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.

Suggesting Enhancements

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.

• Use a clear and descriptive title for the issue to indentify 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.
• Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of Atom which the suggestion is related to.

Pull Request Process

1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
2. You must properly describe whats your PR contains.
3. Ensure that your code is properly indented. You shuld run yarn lint and yarn format before commiting.
4. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.lint
5. After you submit your Pull Request, verify that all status checks are passing.
6. You may merge the Pull Request in once you have the sign-off of at least of one developer, or if you do not have permission to do that, you may request the reviewer to merge it for you.

Styleguides

Check out `.prettierrc` and `eslint` for a more technical details

SCSS

- For styling, we use SCSS and [BEM](http://getbem.com/) as styling metodologhy.

Git Commit Messages

• 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 after the first line
• When only changing documentation, include [ci skip] in the commit title
• Consider starting the commit message with an applicable emoji:
  • 🎨 🎨 when improving the format/structure of the code
  • 🐎 🐎 when improving performance
  • 🚱 🚱 when plugging memory leaks
  • 📝 📝 when writing docs
  • 🐧 🐧 when fixing something on Linux
  • 🍎 🍎 when fixing something on macOS
  • 🏁 🏁 when fixing something on Windows
  • 🐛 🐛 when fixing a bug
  • 🔥 🔥 when removing code or files
  • 💚 💚 when fixing the CI build
  • ✅ ✅ when adding tests
  • 🔒 🔒 when dealing with security
  • ⬆️ ⬆️ when upgrading dependencies
  • ⬇️ ⬇️ when downgrading dependencies
  • 👕 👕 when removing linter warnings