Covid Today India is an open sourced project. which means that anyone can collaborate in building it. Thank you for devoting your time and skill towards the project. :)
The project has two repositories which are open to contribution. The workflow is same for both repositories. Please add issues and PRs in the relavent repository.
- Backend repo- the code which imports, cleans and analyses the data to output various indicators.
- UI repo- the code for the website interface and data visualisations
- You can claim existing issues labelled as "available" by commenting on them. An admin will then assign you the issue and you can start to work on it.
- If you have found a problem or want to suggest an improvement or new feature, please file an issue in the relevant repository.
- Once an issue is raised, the project admins will review the issue. The issue will be labelled "available" after successful review.
- You can claim the "available" issues by commenting on them. An admin will then assign you the issue and you can start to work on it.
Once you have been assigned an issue as above, you may proceed to work on it:
- Fork the relevant repository.
- Clone the forked repository to your computer.
- Create a new branch for your changes.
- Make code changes as necessary.
- Commit changes within the new branch.
- Push the new branch to your forked repository.
- Submit a Pull Request to the relevant Covid Today repository explaining your changes and referencing the related issue.
- Name your PR as:
[type]:[description of change]. Types are[add]= add a new feature[try]= experimental feature, "tentatively add"[fix]= fix and update an existing feature
- Keep pull requests as concise as possible. If you're addressing a bug, only submit the fixes for that bug.