Thank you for considering contributing to Potter DB! Your support is invaluable to the growth and success of this open-source project. We welcome contributions in several areas, including code improvements, data enhancements, documentation updates, and more.
-
Backend (API Changes)
If you're passionate about improving the API or API or making changes to the backend, head over to the backend/README.md for detailed instructions. -
Frontend (Website)
For those interested in improving the website's user interface or functionality, please follow the instructions provided in the frontend/README.md for guidance on contributing to the website.
-
Documentation
If you'd like to help improve our project's documentation and want to help users to better understand the API, please follow the guidelines outlined in the docs/README.md. -
Data Enhancements
If you're interested in helping us improve the data in the Potter DB, please refer to the backend/README.md for instructions on how to contribute to the project's data.
If you're new to contributing to open-source projects, we recommend reading this article or watching this video for a step-by-step guide on how to create and submit pull requests. Additionally, our individual README files (linked above) provide specific instructions for each aspect of the project. If you have any concerns or questions, please feel free to reach out to us on GitHub Discussions.
By contributing to Potter DB, you agree that your contributions will be licensed under the MIT license. This ensures that Potter DB remains freely available to the community to use and build upon. Thank you for being a part of the Potter DB community and helping us make this project even better! We look forward to your contributions and collaboration.