Skip to content

Latest commit

 

History

History
50 lines (38 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

50 lines (38 loc) · 1.73 KB

Contributing to CO2.py

Thank you for your interest in contributing to CO2.py! This library aims to estimate carbon emissions from internet data transfers, retrieve grid intensity data, and query the Green Web Foundation's dataset. Contributions of all kinds are welcome, whether you're fixing bugs, suggesting improvements, or adding new features.

How to Contribute

Reporting Issues

If you encounter a bug or have a feature request, please open an issue. Provide the following details:

  • A clear description of the problem or request.
  • Steps to reproduce the issue (if applicable).
  • Relevant screenshots, logs, or error messages.

Suggesting Enhancements

We encourage you to share your ideas for improving CO2.py. Open an issue or start a discussion in the repository to propose your enhancement.

Submitting Code Changes

We use a pull request (PR) workflow for code contributions. Follow these steps to submit your changes:

  1. Fork the Repository
    Fork the repository to your GitHub account to start working on your changes.

  2. Clone the Fork

    git clone https://github.com/your-username/CO2.py.git
cd CO2.py

  3. Create a New Branch Create a branch for your feature or bugfix:

git checkout -b feature/your-feature-name

and i am sure you know how to do the rest XD

Setting Up the Development Environment

Install Python (>=3.8) and pip.

  1. Clone the repository
  2. Set up a virtual environment:
python -m venv venv
source venv/bin/activate  # On Windows: venv\\Scripts\\activate
  1. Install dependencies:
pip install -r requirements.txt

Thank you for contributing to CO2.py and helping us make the internet greener!