How to Contribute

WEMEP is hosted in GitHub to become an open-source community project. For now, only invited participants from the Wakebench community are contributing to complete the first release.

These are some basic steps to get started when you are ready to contribute.

1. Of course you need a GitHub account. It is through your username that the project tracks your contributions.

2. Make a local copy of the WEMEP master repository.

   $ git clone https://github.com/windbench/WEMEP.git
   

3. Install the libraries that are needed to compile the docs.

   $ pip install -r requirements.txt
   

4. Find the chapter you want to edit in the .rst files and edit it with your favorite text editor using Sphinx syntax.

5. Build the docs into a local html copy at /WEMEP/_build/html

   $ make html
   

6. You can now open your local copy of the WEMEP website (/WEMEP/_build/html/index.html) in your browser and see how your changes look like.

7. Add and commit changes to the master repository with a short description (less than 50 characters) in the “Commit message”

   $ git add *
   $ git commit -m "Commit message"
   $ git push origin master
   

# Read the Docs takes care of hosting the WEMEP website. Your commit will be automatically build by RTD