Skip to content

Commit 380fd9a

Browse files
Enhance contribution instructions in README
Added detailed contribution guidelines to the README.
1 parent c13d42f commit 380fd9a

File tree

1 file changed

+114
-0
lines changed

1 file changed

+114
-0
lines changed

README.md

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,120 @@ Our goal was to aggregate community best practices, *not* what GitHub (or any ot
1212

1313
This site is powered by [Jekyll](https://jekyllrb.com/). Check out our [contributing guidelines](/CONTRIBUTING.md) for ways to offer feedback and contribute.
1414

15+
### How to Contribute Code
16+
17+
We welcome your code contributions! Please follow these steps to ensure a smooth contribution process:
18+
19+
1. **Fork the Repository**
20+
Click the "Fork" button at the top right of this repository to create your own copy.
21+
22+
2. **Clone Your Fork**
23+
Clone your forked repository to your local machine:
24+
```bash
25+
https://github.com/github/opensource.guide.git
26+
```
27+
28+
3. **Create a New Branch**
29+
Create a new branch to work on your changes. Give it a descriptive name:
30+
```bash
31+
git checkout -b my-feature-or-fix
32+
```
33+
34+
4. **Install Dependencies**
35+
Make sure you have all necessary dependencies installed:
36+
```bash
37+
npm install
38+
```
39+
or, if you use Yarn:
40+
```bash
41+
yarn install
42+
```
43+
44+
5. **Make Your Changes**
45+
Edit the code or documentation as needed. Be sure to follow the repository’s coding standards and guidelines.
46+
47+
6. **Test Your Changes**
48+
Run the test suite to ensure your changes do not break existing functionality:
49+
```bash
50+
npm test
51+
```
52+
or
53+
```bash
54+
yarn test
55+
```
56+
57+
7. **Commit Your Changes**
58+
Commit your changes with a clear and descriptive message:
59+
```bash
60+
git add .
61+
git commit -m "Brief description of your changes"
62+
```
63+
64+
8. **Push to Your Fork**
65+
Push your branch to your forked repository:
66+
```bash
67+
git push origin my-feature-or-fix
68+
```
69+
70+
9. **Open a Pull Request**
71+
- Go to the original repository: https://github.com/github/opensource.guide
72+
- Click "New pull request"
73+
- Select your branch from your fork as the source
74+
- Provide a clear and detailed description of your changes
75+
- Submit the pull request
76+
77+
10. **Participate in the Review**
78+
Be responsive to feedback and suggestions from maintainers. Make any requested changes and push to your branch to update the pull request.
79+
80+
---
81+
82+
Thank you for your contribution! For more details, please review our [contributing guidelines](/CONTRIBUTING.md).
83+
84+
---
85+
86+
## Features
87+
88+
Open Source Guides is a comprehensive resource aimed at helping individuals, communities, and organizations successfully participate in and manage open source projects. The repository offers the following key features:
89+
90+
### 1. Comprehensive Guides
91+
A collection of in-depth, topic-based guides covering a wide range of open source practices and concepts. These guides are designed to educate contributors, maintainers, and organizations on essential open source topics, such as:
92+
93+
- Starting an open source project
94+
- Best practices for maintaining projects
95+
- Understanding open source licensing and legal considerations
96+
- Building and nurturing inclusive communities
97+
- Improving project documentation
98+
- Managing governance and leadership in open source
99+
100+
### 2. Community-Driven Content
101+
Content is collaboratively developed and reviewed by the open source community and experts. Contributions are encouraged from anyone, ensuring that the guides reflect best practices and diverse perspectives.
102+
103+
### 3. Contributor Guidelines
104+
Clear and accessible [contributing guidelines](/CONTRIBUTING.md) to help new and experienced contributors get involved, propose changes, and participate in discussions around open source practices.
105+
106+
### 4. Multi-Language Support
107+
Guides are translated into multiple languages to make open source knowledge accessible globally. Community members can contribute translations or improvements to existing ones.
108+
109+
### 5. Open Licensing
110+
All content is released under the [Creative Commons CC-BY-4.0 License](https://creativecommons.org/licenses/by/4.0/), making it easy to share, adapt, and reuse the material in other projects or educational resources.
111+
112+
### 6. Easy Deployment and Access
113+
Powered by [Jekyll](https://jekyllrb.com/), the repository automatically builds and deploys the guides to [https://opensource.guide/](https://opensource.guide/), providing a user-friendly web experience.
114+
115+
### 7. Active Issue Tracker
116+
A robust [issue tracker](https://github.com/github/opensource.guide/issues) allows users to report bugs, suggest topics, request improvements, and discuss ideas with maintainers and the community.
117+
118+
### 8. Continuous Integration
119+
Automated workflows ensure that all contributions are reviewed and tested before being merged, maintaining the quality and reliability of the published guides.
120+
121+
### 9. Community Recognition
122+
An explicit [Acknowledgements](#acknowledgements) section highlights core authors and community contributors, recognizing the individuals who have shaped the project.
123+
124+
### 10. Educational Purpose
125+
The guides are intended for educational use and do not provide legal advice, with a clear [disclaimer](notices.md#legal-disclaimer) to help users understand their application and limitations.
126+
127+
---
128+
15129
## Licenses
16130

17131
Content is released under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/). See [notices](notices.md) for complete details, including attribution guidelines, contribution terms, and software and third-party licenses and permissions.

0 commit comments

Comments
 (0)