CONTRIBUTING.md

Getting Started

• Read about setting development environment.
• Follow our code of conduct.
• Find an issue to work on and start smashing!
• Ask a question on Zulip or join gitter community.

Contributing Guidelines

When contributing to this repository, please first discuss the change you wish to make via an issue.

Make sure you read the README.md.

If you have got any questions, you can also join our zulip chat or you are always welcome to join our gitter community to chat about your queries in real-time.

Remember that this is an inclusive community, commited to creating a safe, positive environment. See the whole Code of Conduct and please follow it in all your interactions with the project.

Format rules

• Indent with two spaces instead of tab.
• Insert final new line at the end of each file.
• Maximum line length should be 200.
• Trim trailing spaces.

If you prefer using EditorConfig, these rules are also there in .editorconfig.

Note: Do not touch emoji.json, this file is intentionally unformatted.

Best Practices for reporting or requesting for Issues/Enhancements:

• Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.
• Follow the Issue Template while creating the issue.
• Include Screenshots if any (specially for UI related issues).
• For UI enhancements or workflows, include mockups to get a clear idea.

Best Practices for getting assigned to work on an Issue/Enhancement:

• If you would like to work on an issue, inform in the issue ticket by commenting on it @kpbot claim.
• Please be sure that you are able to reproduce the issue, before working on it. If not, please ask for clarification by commenting or asking the issue creator.

Development environment

These are some succint steps to set up a development environment:

1. Install git on your computer.
2. Register to GitHub.
3. Fork BAAT CHEET.
4. Clone your fork.
5. Create a new branch.
6. Make changes (follow format rules).
7. Run tests using npm run test, and fix if you see any warning or error.
8. Commit your changes.
9. Push to your fork.
10. Open a pull request

That's it! Thank you for your contribution!