Skip to content

Commit ea0ca80

Browse files
authored
Added Contribution Guide (#65)
* added contribution guide * added reference to coding style
1 parent 788acfb commit ea0ca80

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

contribution_guide.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Contribution Guide
2+
3+
## Welcome
4+
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.
5+
Before you begin, make sure to go through the [README.md](https://github.com/openclimatefix/Open-Source-Quartz-Solar-Forecast/blob/main/README.md) file of project to understand the project.
6+
7+
## Environment Setup
8+
`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.
9+
10+
### Clone the Repository
11+
Follow the following steps to setup the project on your machine.
12+
13+
14+
1. Fork the [Open-Source-Quartz-Solar-Forecast repository](https://github.com/openclimatefix/Open-Source-Quartz-Solar-Forecast) 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.
15+
16+
2. Clone your fork of the project by running the following command:
17+
```
18+
git clone https://github.com/<Your GitHub handle>/Open-Source-Quartz-Solar-Forecast.git
19+
```
20+
21+
3. Navigate to the directory.
22+
```
23+
cd Open-Source-Quartz-Solar-Forecast
24+
```
25+
26+
4. Start contributing!!!
27+
28+
29+
## How to Contribute
30+
31+
For contributing to Open Climate Fix project, we recommend following these detailed steps.
32+
33+
### Step 1: Find an Issue to Work On
34+
Begin by exploring the issues listed on the project's GitHub [issues](https://github.com/openclimatefix/Open-Source-Quartz-Solar-Forecast/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.
35+
36+
### Step 2: Communicate Your Interest
37+
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.
38+
39+
### Step 3: Create a New Branch
40+
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.
41+
42+
### Step 4: Open a Pull Request (PR)
43+
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.
44+
45+
### Step 5: Request a Review
46+
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.
47+
48+
> Don't forget to keep your local repository and fork updated with the main project to ease future contributions.
49+
50+
## Code Style
51+
For checking our coding style, please refer to [coding_style.md](https://github.com/openclimatefix/.github/blob/main/coding_style.md).

0 commit comments

Comments
 (0)