How to propose changes to open-source software using GitHub pull requests

• Documentation: palewi.re/docs/first-pull-request
• Issues: https://github.com/palewire/first-pull-request/issues

Contributing to the docs

The documentation for this site is published via Sphinx and written in Markdown files in the docs directory.

An edit there followed by push to the master branch on GitHub will trigger the docs being redeployed to https://palewi.re/docs/first-pull-request/.

Running the docs locally

Fork the repository and clone it to your computer. Then enter the directory and install the dependencies with pipenv.

pipenv install --dev

Start the test server.

make

Visit localhost:8000 in your browser and you should see the site. Edits you make in the /docs/ folder should show up automatically.