2.3 KiB
2.3 KiB
Contributing
I want to contribute code
- Set up your development environment.
- Communicate with contributors on Discord.
- Pick a backlog card to work on. To get started, it is recommended you pick a card with the
good first issuetag. - Before starting to code, you should engage in conversation with contributors on Discord to ensure that the card is still relevant and get help or additional context if needed.
I want to contribute artwork/design
Reach out to contributors on Discord to discuss what you want to contribute. You can also check the backlog for cards related to design.
I want to report a bug or a problem
Make an issue. Before creating an issue, make sure that:
- You list the steps to reproduce the problem to show that other users may experience it as well, if the issue is not self-descriptive.
- You provide a clear description of the problem, including any error messages or unexpected behavior.
- You include relevant information such as your operating system, browser version, and any other details that may help in diagnosing the issue.
- Search to make sure it isn't a duplicate.
I want to suggest a feature
Discussions regarding whether a proposed new feature would be useful should be done on Discord. Make sure that the feature you propose:
- Is effective in delivering a goal. A feature that adds nothing new or improves nothing is purely fancy.
- Is clear and concise. If ambiguities exist, define them or propose options.
- Is not a duplicate. Check the backlog to see if the feature is already planned or in progress.
- Doesn't rely on mundane assumptions. Non-technical people have the tendency to measure how difficult / easy a feature is to implement based on their unreliable instincts, and such assumptions waste everyone's time. Point out what needs to happen, not what you think will happen.