sendou.ink/CONTRIBUTING.md
2022-07-16 16:15:19 +03:00

1.5 KiB

Contributing

How to contribute

Creating issues

You are free to create issues about bugs, feature requests or just questions about the project. Try to include all relevant information e.g. with bugs what browser you have tested and how to reproduce.

Making pull request

  1. Identify an issue to work on
  • Issues I have identified as potentially good for external contributors are marked with the help wanted tag.
  • Alternatively if there is something else you want to work on (maybe a bug you found or a new feature) I recommend creating a new issue about it before making a pull request. This way I can give any pointers or identify any problems before you use time to make the pull request.
  1. Leave a comment to the issue that you will be working on it.

  2. Make pull request

  • Tell me how I can test it and include unit / E2E tests if possible.

I try to review any pull requests without delay. Note that since this is my personal project I have some opinions on how the code should look. Due to this I might make some nitpicky adjustments directly to your contribution or point out even relatively minor issues in the code review.

Help

If you need help with anything related to contributing we have a Discord server. Especially the "development" channel is meant for this.

Code of conduct

Contributor Covenant applies.