contributing

How to contribute#

  1. Install Python 3.13.1 or later.
  2. Install the required packages: 
pip install -r requirements.txt
  1. Go to the docs directory: 
cd r2docs
  1. Serve the documentation locally: 
mkdocs serve

Contributing#

If you would like to contribute to this project, please follow these steps:

  1. Fork the repository on Github and clone it to your local machine. 
# replace YOURUSERNAME with your github username
git clone https://github.com/<YOURUSERNAME>/twr2docs.git
cd twr2docs
  1. Create a new branch for your feature or bug fix. 
 git checkout -b feature/my-feature
  1. Make your changes and commit them. 
 git add .
 git commit -m "Add my feature"
  1. Push your changes to your forked repository. 
git push origin feature/my-feature
  1. Create a pull request to the main repository.