/notes

Notes for developers

Primary LanguageHTMLGNU General Public License v3.0GPL-3.0

Notes

A repository of notes for developers, especially beginners. Intended as a quick reference to get started.

To start contributing:

  1. Fork this repository into your personal account. A fork is basically a copy of the original repository that you own. That let's you make changes, test and save them on github without ever touching the original repository. Once you are done with your changes, you can give a pull request to this original repository from your fork.
  2. Clone your fork into your local development machine.
  3. cd into the cloned folder. Create and activate the virtualenv. pip install -r requirements.txt to install dependencies.
  4. Make changes. Learn more about making changes by reading the note on Basics.
  5. Commit your changes. Learn more about committing changes.
  6. Test your changes by running mkdocs serve to start a development server.
  7. Push your changes to the forked repository on github account.
  8. Submit a pull request to the original repository.Screenshot 2022-09-17 at 12 40 05 PM