Contributing#

Contributing to the Brightway Code#

If you would like to contribute to the development of Brightway, follow the usual GitHub process: Fork the relevant Brightway repository on GitHub, make your changes and open a pull request with your changes. The Brightway project has adopted the Contributor Covenant.

Contributing to the Brightway Documentation#

Warning

The processing of all requests is handled on a best-effort basis by the community of Brightway developers.

Option 1: Request Changes or Report Errors#

Create a new discussion in the ideas section of the brightway-documentation repository, detailing your request and all relevant information.

Option 2: Contribute Changes#

Note

This is recommended for Brightway users with limited experience in software development and version control tools.

Prerequisites

  1. basic knowledge of GitHub (issues, discussions, etc.)

  2. basic knowledge of Markup

  1. Prepare your contribution using the Markdown (.md) syntax and save it to a single file.

  2. Start a new discussion in the ideas section of the brightway-documentation repository and attach the Markdown file to the discussion. The discussion must include the intended location of your page in the Brightway documentation.

  3. A member of the Brightway developers community will integrate your contribution into the documentation.

Note

This is recommended for Brightway users with experience in software development and version control tools. The technical infrastructure of the Brightway documentation is detailed on the Contributing Guide pages for the General Documentation and the API Documentation.

Prerequisites

  1. knowledge of GitHub (pull-requests, etc.)

  2. knowledge of Markup

  3. knowledge of reStructured Text

  4. basic knowledge of Sphinx

  1. Fork the brightway-documentation repository.

  2. Add your contributions and build the documentation locally (compare the repository readme)

  3. Open a pull request

  4. A member of the Brightway developers community will merge your contribution into the main branch of the documentation repository. Your changes will be published to the documentation website automatically following the successful merge.