Skip to content

Latest commit

 

History

History
26 lines (15 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

26 lines (15 loc) · 1.4 KB

How to Contribute

This project is open to anyone in the community. Developers can contribute by adding code, and non-developers can contribute by improving docs.

Please make sure the code you add here follows best practices and coding conventions. This repository is meant for beginners and someone who is new to a framework must not be misguided with bad quality code. That being said, any kind of improvememt is welcome.

If you want to add something new to the repository that hasn't been added as an issue, please open a new issue first.

Follow the steps below to start contributing:
  1. Fork this repository.
  2. Clone your forked repository
  3. Create a new branch with the name as follows - <your-name>/<issue-number>/<your-changes>. Or you can just add changes to the master branch of your fork.
  4. Add all the relevant code and tests. We encourage everyone to improve the readme as well! :)
  5. Push your code to your branch.
  6. Finally, open a PR against the master branch of this repository.

Please also remember to update the .gitignore file when adding code for a new project when necesary. Or just have a .gitignore file in the project dir.

Also, make sure you update the main README file to add your project.

If you want an example, have a look at the flask hello world app.

Good luck!