Thank you for investing your time in contributing to our project! ✨.
Read our Code of Conduct to keep our community approachable and respectable.
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:
- Finding ways to contribute to open source on GitHub
- Set up Git
- GitHub flow
- Collaborating with pull requests
To contribute to this project, you must have basic understanding of Python and Python Packages
If you spot a problem within the program, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.
Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
All the UI is made using HTML, CSS (Bootstrap) and Jinja Templating Engine. You can find all the code for UI in templates folder
This project follows a simple folder structure. If you want to make change which is related to manga, you can find all the code in manga folder. If the change is related to Home page or About Page, you can find it's code in main folder.
Commit the changes once you are happy with them.
When you're finished with the changes, create a pull request, also known as a PR.
- Don't forget to link PR to issue if you are solving one. Once you submit your PR, we may ask questions or request additional information.
- We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can make any other changes in your fork, then commit them to your branch.
- As you update your PR and apply changes, mark each conversation as resolved.
- If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.
Congratulations 🎉🎉✨.
Once your PR is merged, your contributions will be publicly visible on the MyMangaDataBase Contributors.