You are free to contribute to Code4Nepal via GitHub Pull Requests.
- Always do your best to ensure a good user experience
- Repeatability and consistency is important for reuse
- Prefer reuse over building from scratch
- Use pip to manage dependencies.
- Version your dependencies. Use pip freeze to save dependencies into a single requirements.txt file.
- Follow PEP8 as a python style guide so as to be consistent with other python libraries and tools.
- Use virtualenv to sandbox your projects.
- Never commit sensitive credentials or other information into the repo. If it happens accidentally, remove them from the source and change them.
- Sensitive data should be injected into the application through environment variables or some other mechanism that doesn’t involve checking it into source control.
A successful git branching model
- Fork this repo.
- Commit your changes
git commit -am "New feature"on the dev branch. - Push using
git push origin dev. - Open a Pull Request.
- Wait for the reviewers to accept the request or provide insightful feedback to improve your contribution.
Comments get filtered out when compiling. If you do anything that can not be immediately understood: comment it.