👍🎉 First off, thanks for taking the time to contribute! 🎉👍
This document is intended for anyone considering opening an issue, discussion or pull request.
Note
This is a personal project that I maintain in my free time. If you're expecting me to dedicate my personal time to fixing bugs, maintaining features, and reviewing code, I do kindly ask you spend a few minutes reading this document. Thank you. ❤️
- Code of Conduct
- Users are not allowed to create Issues directly
- Use of AI
- I have a bug! / Something isn't working
- I have an idea for a feature
- I want to make changes
- Spread the word
- Support the project financially
This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code.
Users are not allowed to create Issues directly in this repository - we ask that you create a Discussion first.
This project does not use the issue tracker for discussion or feature requests. Instead, we use GitHub discussions for that. Once a discussion reaches a point where a well-understood, actionable item is identified, it is moved to the issue tracker. This pattern makes it easier for maintainers or contributors to find issues to work on since every issue is ready to be worked on.
Any Discussion which clearly identifies a problem and can be confirmed or reproduced will be converted to an Issue by a maintainer, so as a user finding a valid problem you don't do any extra work anyway. Thank you.
We welcome use of AI tools to help draft discussions, issues, or code, but please follow these rules:
- Use AI tools responsibly and disclose their use.
- Ensure all content passes a human review for authenticity and quality.
- Be concise. Do not write verbose discussions, issues or PR.
Discussions, issues or PR that consist solely of unvetted AI outputs may be closed at the maintainer's discretion.
First, search the issue tracker and discussions for similar issues.
Tip: also search for closed issues and closed discussions; your issue might have already been fixed!
Note
If there is an open issue or discussion that matches your problem, please do not comment on it unless you have valuable insight to add.
Use the handy upvote button for discussions, and/or emoji reactions on both discussions and issues, which are a visible yet non-disruptive way to show your support.
If your issue hasn't been reported already, open an "Issue Triage" discussion and make sure to fill in the template completely. They are vital for maintainers to figure out important details about your setup.
Warning
Please make sure that you only use the "Issue Triage" category for reporting bugs — thank you!
Like bug reports, first search through both issues and discussions and try to find if your feature has already been requested. Otherwise, open a discussion in the "Feature Requests, Ideas" category.
Small and trivial improvements can be submitted without any discussion.
For non-trivial changes, pull requests should be associated with a previously accepted issue.
It's always better to ask for prior approval and discuss what you want to do before doing it.
Discussing that you want to do something doesn't put any obligations on you. If you don't want to start the discussion just because you're afraid that you won't do it. Don't be afraid!
Note
Pull requests are NOT a place to discuss feature design. Please do not open a WIP pull request to discuss a feature. Instead, use a discussion and link to your branch.
When implementing features and bug fixes, please stick to the structure of the codebase as much as possible and do not take this as an opportunity to do some "refactoring along the way".
Similarly:
- Make your changes following our code standards
- Test your changes thoroughly
- Update documentation if needed
- Commit your changes with clear, descriptive commit messages
Do you like the project?
- Spread the word in social networks!
- Talk about it to your colleagues and friends
- Write a blogpost
- Record a YouTube video
Supporting the project financially counts as a contribution (even if it's just a $1/month).
 |
ko-fi.com/daiyam |
 |
liberapay.com/daiyam/donate |
 |
paypal.me/daiyam99 |