Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 114 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,120 @@ Our goal was to aggregate community best practices, *not* what GitHub (or any ot

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

### How to Contribute Code

We welcome your code contributions! Please follow these steps to ensure a smooth contribution process:

1. **Fork the Repository**
Click the "Fork" button at the top right of this repository to create your own copy.

2. **Clone Your Fork**
Clone your forked repository to your local machine:
```bash
https://github.com/github/opensource.guide.git
Copy link

Copilot AI Oct 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing git clone command. The URL should be preceded by the git clone command.

Suggested change
https://github.com/github/opensource.guide.git
git clone https://github.com/github/opensource.guide.git

Copilot uses AI. Check for mistakes.

```

3. **Create a New Branch**
Create a new branch to work on your changes. Give it a descriptive name:
```bash
git checkout -b my-feature-or-fix
```

4. **Install Dependencies**
Make sure you have all necessary dependencies installed:
```bash
npm install
```
or, if you use Yarn:
```bash
yarn install
```

5. **Make Your Changes**
Edit the code or documentation as needed. Be sure to follow the repository’s coding standards and guidelines.

6. **Test Your Changes**
Run the test suite to ensure your changes do not break existing functionality:
```bash
npm test
```
or
```bash
yarn test
```

7. **Commit Your Changes**
Commit your changes with a clear and descriptive message:
```bash
git add .
git commit -m "Brief description of your changes"
```

8. **Push to Your Fork**
Push your branch to your forked repository:
```bash
git push origin my-feature-or-fix
```

9. **Open a Pull Request**
- Go to the original repository: https://github.com/github/opensource.guide
- Click "New pull request"
- Select your branch from your fork as the source
- Provide a clear and detailed description of your changes
- Submit the pull request

10. **Participate in the Review**
Be responsive to feedback and suggestions from maintainers. Make any requested changes and push to your branch to update the pull request.

---

Thank you for your contribution! For more details, please review our [contributing guidelines](/CONTRIBUTING.md).

---

## Features

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:

### 1. Comprehensive Guides
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:

- Starting an open source project
- Best practices for maintaining projects
- Understanding open source licensing and legal considerations
- Building and nurturing inclusive communities
- Improving project documentation
- Managing governance and leadership in open source

### 2. Community-Driven Content
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.

### 3. Contributor Guidelines
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.

### 4. Multi-Language Support
Guides are translated into multiple languages to make open source knowledge accessible globally. Community members can contribute translations or improvements to existing ones.

### 5. Open Licensing
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.

### 6. Easy Deployment and Access
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.

### 7. Active Issue Tracker
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.

### 8. Continuous Integration
Automated workflows ensure that all contributions are reviewed and tested before being merged, maintaining the quality and reliability of the published guides.

### 9. Community Recognition
An explicit [Acknowledgements](#acknowledgements) section highlights core authors and community contributors, recognizing the individuals who have shaped the project.

### 10. Educational Purpose
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.

---

## Licenses

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.
Expand Down
Loading