Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 3.5 KB

contribution_guide.md

File metadata and controls

51 lines (33 loc) · 3.5 KB
Raw

Contribution Guide

Welcome

Welcome to Open Climate Fix project! Open Climate Fix fosters an inclusive open-source community, welcoming participation from everyone. We value all forms of contributions, whether to our codebase or documentation, and we appreciate your support. Before you begin, make sure to go through the README.md file of project to understand the project.

Environment Setup

Open-Source-Quartz-Solar-Forecast project is developed with Python, that supports our open-source PV forecast model's computational needs. To set up and contribute to the project, Python version 3 is required.

Clone the Repository

Follow the following steps to setup the project on your machine.

  1. Fork the Open-Source-Quartz-Solar-Forecast repository by clicking on the ‘Fork’ button. This creates a copy of the code under your GitHub user account. Your fork will have your own GitHub username.

  2. Clone your fork of the project by running the following command:

git clone https://github.com/<Your GitHub handle>/Open-Source-Quartz-Solar-Forecast.git
  1. Navigate to the directory.
cd Open-Source-Quartz-Solar-Forecast
  1. Start contributing!!!

How to Contribute

For contributing to Open Climate Fix project, we recommend following these detailed steps.

Step 1: Find an Issue to Work On

Begin by exploring the issues listed on the project's GitHub issues page. If you're new to the project, look for issues tagged with good first issue, these are specifically selected to be more accessible for newcomers. Selecting an issue that aligns with your interests or expertise is a great way to contribute effectively.

Step 2: Communicate Your Interest

Before diving into coding, it's a good practice to comment on the issue you're interested in. This lets the maintainers know you're working on it and prevents duplicate efforts. It's also an excellent opportunity to ask any clarifying questions and discuss your approach.

Step 3: Create a New Branch

For every new contribution, create a branch in your local repository. A branch is a way to keep your changes seprate from the main part of the project called main. This branch should be based off the main project's latest main branch. Naming your branch with a convention like feature/your-feature-name or fix/issue-description can help identify its purpose.

Step 4: Open a Pull Request (PR)

Once you're satisfied with your contribution, push your branch to your fork on GitHub and open a pull request against the original Open Climate Fix repository. In your pull request description, reference the issue you're addressing and provide a summary of your changes. Providing screenshots or output snippets can be particularly helpful for visual changes or user interface improvements.

Step 5: Request a Review

After submitting your pull request, you can request a review from the project maintainers or specific contributors by mentioning them in your PR comments. Once your pull request is approved, a project maintainer will merge it into the main branch.

Don't forget to keep your local repository and fork updated with the main project to ease future contributions.

Code Style

For checking our coding style, please refer to coding_style.md.