Skip to content

Latest commit

 

History

History
79 lines (51 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

79 lines (51 loc) · 2.48 KB
Raw

Making Contributions

🎉 Thank you for considering contributing to the "Guide to Open Source" project! Your contributions help make this guide more valuable for everyone in the open-source community.

Table of Contents

  1. How to Contribute
  2. Reporting Issues
  3. Feature Requests
  4. Pull Requests
  5. Code Style Guidelines
  6. Commit Message Guidelines
  7. Acknowledgements

How to Contribute

Whether you're fixing a typo, adding a section, or addressing a bug, your contributions are welcome. To contribute, follow these steps:

  1. Fork this Repository: Fork this repository to your GitHub account by clicking the "Fork" button at the top of this page.

  2. Clone Your Fork: Clone your fork to your local machine using the following command (replace <your-username> with your GitHub username):

    git clone https://github.com/<your-username>/oss101.git

  3. Create a New Branch: Create a new branch for your contributions:

    git checkout -b feature/your-feature

  4. Make Changes: Make the necessary changes in your branch.

  5. Commit Changes: Commit your changes with clear and concise commit messages:

    git add .
git commit -m "Add your commit message here"

  6. Push Changes: Push your changes to your fork on GitHub:

    git push origin feature/your-feature

  7. Submit a Pull Request: Open a pull request (PR) from your fork to the main repository. Provide a clear description of your changes.

Reporting Issues

If you encounter any issues with the guide, please open an issue with detailed information about the problem.

Feature Requests

Have an idea for a new section or feature? Submit a feature request and share your thoughts.

Pull Requests

Pull requests are welcome! If you'd like to contribute directly to the guide, follow the steps outlined in the "How to Contribute" section.

Code Style Guidelines

Maintain a clean and consistent code style. Adhering to established coding conventions helps ensure readability and maintainability.

Commit Message Guidelines

Follow commit message guidelines to ensure clear communication and maintain a clean Git history.

Acknowledgements

Thank you to all the contributors who have helped make this guide better! Your efforts are highly appreciated.