Contributing to LCFS

November 10, 2023 ยท View on GitHub

We welcome contributions to the Low Carbon Fuel Standard (LCFS) project. By participating in this project, you agree to abide by its terms.

How to Contribute

Reporting Bugs

Before creating bug reports, please check the known issues as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible by filling out the provided template.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for LCFS, including completely new features and minor improvements to existing functionality. Again, please check the issue tracker before creating enhancement suggestions to see if the feature has already been requested. Fill in the template as completely as possible when listing your suggestion.

Pull Requests

The process described here has several goals:

  • Maintain LCFS's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible LCFS
  • Enable a sustainable system for LCFS's maintainers to review contributions

Please follow these steps to have your contribution considered by the maintainers:

  1. Follow all instructions in the template
  2. Follow Github Flow for branch and commit style.
  3. After you submit your pull request, verify that all status checks are passing

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

Development Setup

Please refer to the main README.md file for the detailed setup.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Python Styleguide

Follow the PEP 8 Style Guide for Python Code.

JavaScript Styleguide

Adhere to the JavaScript Standard Style.

Documentation Styleguide

Use Markdown.

Community and Behavioral Expectations

Participation in the LCFS community is governed by the LCFS Code of Conduct.

License

By contributing to LCFS, you agree that your contributions will be licensed under its Apache License 2.0.

Acknowledgements

Thank you for contributing to LCFS, thereby helping us to improve the management and compliance of low carbon fuel standard.