Contributing Guide

How to contribute

• Fork the project from the master branch and submit a Pull Request (PR)

  • Explain what the PR fixes or improves.

• If you want to add a new repo:

  • Open the input_data.json

  • Add repo url and tech stack there.

• If you want to add more content or modify the content in the README file, then modify the README.model.md file. DO NOT DIRECTLY MODIFY THE README file, the changes won't persist. Go to README.model.md file and then edit there. Your edits in the README.model.md will sync to README in few moments.

  • For example, if you want to add new table to the README, you open the README.model.md file, and add there.

• Use sensible commit messages

  • If your PR fixes a separate issue number, include it in the commit message.

• Use a sensible number of commit messages as well

  • e.g. Your PR should not have 1000s of commits.