Skip to content

Contributing

Contributing

Contributions are both encouraged and greatly appreciated.

To contribute content, fork this repo and make a pull request to the master branch including your changes.

  • On GitHub, fork the p2pool-api repo
  • Clone your newly created repo. (Note: replace your-username with your GitHub username)

via ssh:

git clone git@github.com:your-username/p2pool-api

via https:

git clone https://github.com/your-username/p2pool-api
  • Navigate to the repo and create a new topic branch
cd p2pool-api
git checkout -b foobar
  • After making modifications, commit and push your changes to your topic branch
  • Open a PR against the p2pool-api main branch

Run the documentation server locally

This documentation can be built and run locally.

  • The build process for mkdocs utilizes Python
  • It is recommended to install python pip dependencies inside of a Virtual Environment (venv)

Note: You may need to first install python3-venv or the equivalent for your distribution

  • Navigate to your p2pool-api repo
  • Create the python virtual environment
python3 -m venv .venv
source .venv/bin/activate
  • Install mkdocs dependencies to the venv
pip install -r requirements.txt
  • Run the documentation server locally
mkdocs serve