Thank you for supporting AcadeMe and looking for ways to help. We surely apperciate open source contributers! But before you contribute, please make sure to follow these guidelines.
- Fork the repository!
- Clone the repository!
We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy! Great Bug Reports tend to have:
- A quick summary and/or background.
- Steps to reproduce.
- Be specific!
- Give sample code if you can.
- What actually happens.
- Make it visual - use photos and screenshots if you can.
- If the issue represents a feature needed to be implemented, write acceptance criteria for it!
People love thorough bug reports. I'm not even kidding.
- Make SMALLER pull requests.
- Write useful descriptions and titles.
Example:"[Frontend] Login Page UI" "I have made several changes to the Login Page interface: 1.'forgot password' checkbox 2.Logo alignment" - Have on-point commit messages.
- When submiting a PR link the relevant issue to it in the first PR message.
Closes #78
We have set up Flake8 to ensure that our style guides are being followed.
In case of work in progress PR, make sure it is in Draft state, under the reviewers section in github ui. Pull requests should be thoroughly tested and ready to merge before they are submitted.
Tests should be be part of the PR in case of new features or capabilities proposed in the PR.
PR will be reviewed with the following prerequisite: PR checks are passed with SUCCESS. All the pull requests guidelines are enforced.