Skip to content

Latest commit

 

History

History
48 lines (29 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

48 lines (29 loc) · 2.79 KB
Raw

Contributing

At CoderDojoKC, we would like to provide a nice way for the community to help improve our lessons.

Code of Conduct

We follow the CoderDojo Charter and adhere to the Kansas City Women in Technology Code of Conduct

Text Markup

This project uses two different kinds of text markup:

If you're writing something without images or tables, you can use Markdown. It provides an easy and quick way to create formatted text with lists and nicely formatted code examples. Here is a good Markdown cheatsheet.

If you're writing something with images or tables, please write it using restructuredText. RestructuredText uses a semantic markup that allows one to create accessible documentation. For instance, if you have an image that requires a licensing notice or a citation, you can more easily create a caption in restructuredText than you can in Markdown. Here is a good restructuredText cheatsheet.

Building a local version

Requirements

  • Python 3.5 or higher.

How to

Get Started:

  1. Fork this repository.
  2. Clone this repository to your local development machine: git clone <your-fork.git>.
  3. Change directory into the directory the new repository: cd !$.
  4. Create a Python virtual environment for this project: python3 -m venv venv. Note: Feel free to use whichever tooling you prefer for creating and managing Python virtual environments. The venv module has the benefit of being included with Python 3.5 and higher.
  5. Activate the Python virtual environment: source venv/bin/activate. Note: If you are using a different method of managing Python virtual environments, use its command for activating the virtual environment.
  6. Install the Python dependencies for this project: make dev.

To build an HTML version of this documentation locally:

  1. make html
  2. Open build/html/index.html in your favorite browser

To add a Python package:

  1. Edit either requirements.in or requirements-dev.in (depending on if the package is for use as a project dependency or development dependency) in your favorite text editor and add the name of the package you want to add.
  2. Run make requirements to add it to the requirements.txt or requirements-dev.txt file.
  3. Run make sync to bring your Python virtual environment's installed packages up to date with the newly updated requirements*.txt files.

// todo Making a Pull Request