contributing.md

Contributing Guidelines

First off, thank you for considering contributing to OpenScreeps! Before you deep dive and help out with development, make sure to read the following sections in order to know what and how to work on something. If you need help with anything, feel free to create an issue on GitHub or contact us in #open-screeps on slack.

Code of Conduct

All members of the community are expected to follow the code of conduct.

Getting started

There are several way to contribute to this project, the following section will show you how.

Write code

This section will help you writing code for the OpenScreeps project. It is assumed that you have basic knowledge of how git and GitHub work.

Local Development

Edit an existing module

1. Install dependencies: npm install
2. Make your changes to the module and edit the tests if required
3. Verify the tests are still passing by executing npm test
4. Make sure the readme reflects your changes

Create a new module

1. Install dependencies: npm install
2. Execute npm run create and follow the instructions
3. Create your module and write relevant ava cases
4. Run the tests by executing npm test
5. Make sure the readme is up to date and contains a relevant example

Git Commit Messages

• Follow Conventional Commits
• Use npm run commit to get some assistance creating the commit

Pull Requests

• Fill in the required template
• Do not include issue numbers in the PR title

Review a pull request

TODO

Report a bug

TODO

Request a feature

TODO

Share ideas

TODO