Leahnaya/sendou.ink
1
0
Fork 0
mirror of https://github.com/Sendouc/sendou.ink.git synced 2026-08-01 00:24:13 -05:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
trophy-fixes
sendou.ink/CONTRIBUTING.md
Kalle 5da87d307a Update CONTRIBUTING.md
2026-07-31 11:35:07 +03:00

2.3 KiB
Raw Permalink Blame History

Contributing

Thank you for taking interest in contributing to sendou.ink! Please note that mainly AI driven contributions from people who are not in the community or using the project are not wanted and will not be considered.

How to contribute

Reading the architecture.md file is highly recommended before writing any code to get up to the speed with how the project folder structure works and getting familiar with its concepts.

Bugs

Feel free to submit issues and/or pull requests about bugs. In a bug issue try to include all the relevant information e.g. with bugs what browser you have tested and how to reproduce. Before making an issue use search to make sure one doesn't already exist.

Features

The "product vision" of sendou.ink is controlled mainly by Sendou. Best way to gauge interest about a new feature is to post about it on the feedback channel of our Discord. If it's a feature you personally want to implement you can also state that when opening a Discord topic about it for discussion. We can then work on the idea and create it into a GitHub issue before implementation. Before making a new post use the search functionality to look if one already exists (it's okay to bump it up).

You can also just directly make a pull request but untracked feature requests might be rejected if they are not something that fit the vision. The fact that all new code needs maintaining needs to be weighted against how much it benefits the userbase as well as any connections to other features current or future.

Making pull request

First of all note that a well detailed issue that explains a problem from user point of view with clear examples and code level investigation is often more valuable than a pull request.

When making a pull request what makes it easy to review (which makes it likely to be processed faster) include following:

  1. Change is pre-discussed in an issue or GitHub, direction agreed upon
  2. If many unrelated changes are made, they are opened as separate pull requests (smaller is better generally speaking)
  3. UI changes are showcased with screenshots before/after
  4. Appropriate automated tests exist

Help

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