This document outlines the process for contributing to the Open Source Awesome List. Whether you're a seasoned contributor or new to open source, these guidelines are designed to help you make meaningful contributions to our project.
Getting Started
Before you start contributing, make sure you have:
Contributing Process
- Fork the Repository: Go to the main repository and fork it to your GitHub account.
- Clone the Forked Repository: Clone the forked repository to your local machine.
- Create a New Branch: For each feature or fix, create a new branch from the main branch.
- Implement Your Changes: Make your changes in the new branch. Ensure your code is clean and follows the coding standards.
- Commit Your Changes: Commit your changes with a clear and concise message.
- Push Your Branch: Push the branch to your forked repository on GitHub.
- Open a Pull Request: From your forked repository, open a pull request to the main repository. Make sure to reference the issue or feature you're addressing.
Code of Conduct
All contributions to the Open Source Awesome List must adhere to the Code of Conduct.
Example of a Pull Request
Here's a sample pull request description:
# New Contribution
## Description
This pull request adds a new section to the list focusing on machine learning resources.
## Changes
- Added a new section for machine learning resources.
- Updated the README with the new section.
Community Resources
Contributing to open source is a rewarding experience. We appreciate your contributions and look forward to seeing your pull requests!
Community