Skip to content

Latest commit

 

History

History
64 lines (35 loc) · 3.21 KB

CONTRIBUTING.md

File metadata and controls

64 lines (35 loc) · 3.21 KB

Contributing

Thanks for being willing to contribute!

Help needed

Please checkout the ROADMAP and raise an issue to discuss any of the items

Making Changes

Committing and Pushing changes

Once you are ready to commit the changes, please use the below commands

  1. git add <files to be comitted>
  2. git commit -m 'A meaningful message

Note: please use present tense in commit messages i.e. Add feature X and not Added feature X

Add yourself as a contributor

This project follows the all contributors specification. To add yourself to the table of contributors on the README.md, please use the automated script as part of your PR:

npm run contributor <YOUR_GITHUB_USERNAME>

Follow the prompt. If you've already added yourself to the list and are making a new type of contribution, you can run it again and select the added contribution type. If you need to edit the .all-contributorsrc file by hand that's fine too, just run npm run contributor:generate to regenerate the table

Issue Reporting Guidelines

File a single issue per problem and feature request.

  • Do not enumerate multiple bugs or feature requests in the same issue.
  • Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar, but have different causes.

The more information you can provide, the more likely someone will be successful reproducing the issue and finding a fix.

Please remember to do the following:

  • Search the issue repository to see if there exists a duplicate.
  • Simplify your code around the issue so we can better isolate the problem.

Before Submitting an Issue

First, please do a search for open issues in the issue tab to see if the issue or feature request has already been filed.

If you find your issue already exists, make relevant comments and add your reaction. Use a reaction in place of a "+1" comment.

👍 - upvote

👎 - downvote

If you cannot find an existing issue that describes your bug or feature, submit an issue using the issue template.

Engineering Guidelines

  1. Follow the Atlas City Engineering Guidelines https://github.com/atlascity/Community/wiki/Engineering-Guidelines