When contributing to this repository, please first discuss the change you wish to make via issue or telegram or slack or any other method with the owners of this repository before making a change.
If there is some issue or bug or enhancements, you are interested in and no one else is working on the issue, you may take it up (just leave a comment on the issue).
Make sure you create an issue before making major code changes or adding new features
If this is something you think you can fix, then create a branch with a descriptive name.
The core code for getting the website up and running should be made against master.
For adding new features/fixing issues, a good branch name would be (where issue #13 is the ticket you're working on):
git checkout -b 13-add-xyz-featureAt this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first 😸
make sure that you dont make too many code changes at once and later add everything as a single commit. by adding a new function or by fixing a relevant bug or by adding a new feature, make sure that you commit those chunks of code
kindly add descriptive commit messages. make it elaborate and on point. "fixes errors" is an example for a bad commit message. whereas "fix #331 by removing the call to FuncName() at line 22" is an example of a good commit message.
Your patch should follow the same conventions & pass the same code quality checks as the rest of the project.
At this point, you should switch back to your master branch and make sure it's up to date with Active Admin's master branch:
git remote add upstream git@github.com:yedhink/covid19-kerala-api.git
git checkout master
git pull upstream masterGetting a Permission denied (publickey) error? Follow this guide to fix it.
Then update your feature branch from your local copy of master, and push it!
git checkout 13-add-xyz-feature
git rebase master
git push --set-upstream origin 13-add-xyz-featureFinally, go to GitHub and make a Pull Request :D