Firstly, thank you for considering contributing to our project! Your time and expertise are invaluable to us. Below, I've provided a comprehensive guide to ensure a smooth contribution experience.
-
Familiarize Yourself with the project
Spend time understanding the project's structure, codebase, and overarching goals. That will ensure that your contributions align well with our vision.
-
Read the Monorepo Documentation
I've structured our project as a monorepo. For a detailed understanding of our development practices and how to contribute within this structure, please refer to:
-
Open Communication: Before diving deep into coding, discuss your ideas or the changes you wish to make might. Create an Issue.
-
Follow Coding Standards: Consistency is key. Ensure your code follows the coding conventions and styles of the project.
-
Test Thoroughly: Before submitting your contribution, test your changes thoroughly to ensure they don't introduce new bugs.
-
Documentation: Remember to update the documentation accordingly if your changes introduce new features or modify existing ones.
Thank you for your commitment to improving our project. I eagerly await your valuable contributions. Together, let's make this project even better!