CONTRIBUTING.md

How to contribute

Thank you for investing your time in contributing to the Emissioin Conversion Factor KG

To get an overview of the project, please read the README.

Issues

Create a new issue

If you spot a problem or want to suggest a new term or use case, search if it already exists in our issue tracker. If a related issue does not exist, you can open a new issue here on GitHub.

Proposing new data sources to process

1. If you'd like to suggest new data sources, please open an issue providing its metadata and download options. Make sure it has an open license!

Contributing with a mapping

Mappings for existing open datasets are welcome. In order for your mapping to be acceptable, it should be based on a standard/well known tool, so we can reproduce it. Create your mapping in a new folder and propose your pull request (see below)

Make changes locally

1. Fork the repository.
   • Using GitHub Desktop:
     • Getting started with GitHub Desktop will guide you through setting up Desktop.
     • Once Desktop is set up, you can use it to fork the repo!
   • Using the command line:
     • Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.
2. Create a working branch and start with your changes!

Commit your update

Commit the changes once you are happy with them.

Always write a clear log message for your commits. One-line messages are fine for small changes.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

• Link your PR to the issue it addresses.
• Push your PR to the dev branch. One of the members of the team will merge it in the main branch.