Skip to content

Commit 739936a

Browse files
committed
Added CONTRIBUTING.md
1 parent 30c61eb commit 739936a

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed

docs/CONTRIBUTING.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Contributing to PicoNexus Projects
2+
3+
Thank you for considering contributing to PicoNexus! We welcome contributions from everyone and are grateful for any help you can provide.
4+
5+
## How to Report a Bug
6+
7+
We use GitHub to host code, track [issues](https://github.com/PicoNexus/pico-projects/issues) and feature requests, and to accept [pull requests](https://github.com/PicoNexus/pico-projects/pulls).
8+
9+
10+
## How to Contribute
11+
12+
13+
### 1. Fork the Repository
14+
15+
Fork the [pico-projects repository](https://github.com/PicoNexus/pico-projects) to your own GitHub account.
16+
17+
### 2. Clone Your Fork
18+
19+
Clone your forked repository to your local machine:
20+
21+
```bash
22+
git clone https://github.com/your-username/pico-projects.git
23+
```
24+
25+
### 3. Create a Branch
26+
27+
Create a new branch for your feature or bug fix:
28+
29+
```bash
30+
git checkout -b my-feature-branch
31+
```
32+
33+
### 4. Make Changes
34+
35+
Make your changes to the codebase. Ensure that your code follows the project's coding standards.
36+
37+
### 5. Commit Your Changes
38+
39+
Commit your changes with a descriptive commit message:
40+
41+
```bash
42+
git add .
43+
git commit -m "Add a brief description of your changes"
44+
```
45+
46+
### 6. Push to Your Fork
47+
48+
Push your changes to your forked repository:
49+
50+
```bash
51+
git push origin my-feature-branch
52+
```
53+
54+
### 7. Open a Pull Request
55+
56+
Open a pull request against the main branch of the original repository. In your pull request, provide a clear description of the changes and any relevant information.
57+
58+
59+
## Code of Conduct
60+
61+
Please adhere to our Code of Conduct (CODE_OF_CONDUCT.md) in all interactions. We expect all contributors to foster a welcoming and inclusive environment.

0 commit comments

Comments
 (0)