Thank you for your interest in Ratenect. We welcome you to contribute to our project. To maintain the coding as well as ethical standards, we require you to go through the following guidelines.
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
- Before contributing to this project, you must understand the idea and plan behind the project properly. Go through the
README.mdfile in the root directory and do read the pages redirected throught the links present there. - Introduce yourself in the comment section of the first post on Discussions tab.
We are currently accepting contributions only through the process of solving an Issue. We have created some issues, you can check them here. Just comment on the issue that you want to work on and you will be assigned the same.
We Use Github Flow, So All Code Changes Happen Through Pull Requests. Follow GitHub Docs to learn how to create a Pull request/
To ensure a consistent coding style, we use the Prettier formatter. Make sure that before commiting, you run npx prettier --write . in the terminal to format all the code as per .prettierrc.
You can ask your queries in our Discord Server in the #ratenect channel.