Skip to content

Latest commit

 

History

History
106 lines (64 loc) · 5.12 KB

CONTRIBUTING.md

File metadata and controls

106 lines (64 loc) · 5.12 KB

Preptember

Component_1

Maintaining the quality of contributions is essential to ensure the value and integrity of Hacktoberfest. While we encourage and welcome contributions from all participants, we also want to ensure that the contributions are meaningful and adhere to the principles of open source collaboration. To maintain quality and avoid spammy contributions, we have implemented certain guidelines:

Quality Contributions

We value contributions that:

  • Address real issues or feature requests.
  • Follow the existing coding standards and project conventions.
  • Are well-documented, including clear commit messages and code comments.
  • Include tests when applicable.
  • Enhance the overall functionality and usability of the project.

Warning About Spammy Contributions

While we appreciate all contributions, we want to emphasize that Hacktoberfest is about quality, not quantity. Spammy contributions, such as creating a large number of trivial or unrelated pull requests, can be detrimental to the open-source community.

Warning Process

If we identify spammy contributions, we will follow these steps:

  1. Warning: We will reach out to the contributor through the pull request or issue to discuss the quality of their contributions and suggest improvements.

  2. Educational Resources: We may provide resources or guidance on how to make meaningful contributions to the project.

  3. Ban: Warning: If the contributor continues to submit spammy contributions without making an effort to improve, we may need to take more stringent actions.

Banning from Hacktoberfest

In extreme cases where a contributor consistently submits spammy contributions without addressing the quality concerns, we may have to restrict their participation in Hacktoberfest. This step is not taken lightly and is done to maintain the integrity of the event and the open-source community.

Our Goal

Our goal is to foster a positive and collaborative environment during Hacktoberfest. We encourage everyone to learn, grow, and make meaningful contributions to open-source projects. By following the guidelines and maintaining the quality of contributions, we ensure that Hacktoberfest remains a valuable experience for all participants.

Thank you for your understanding and commitment to the spirit of open source and Hacktoberfest. Together, we can make this event a success while upholding the values of quality and collaboration.


How to install and configure git

Operating System
Windows winget install git.git
MacOS git --version
Ubuntu(Debian) sudo apt install git
Arch sudo pacman -S git
git config --global user.name <github username>
git config --global user.email <email used for github>

How to Contribute in this repo.

Contributing to open-source is easy.

  1. Star and Fork the Repo

    • Feel free to Star:star: the repo, if you like it. star the repo

    • Click on fork button in the right corner.It will create a copy of repository in your account. fork the repo

    • Creating the copy of repository forking the repo

    • Check here How to fork

  2. Clone the Repo

    You can clone your repository in your local pc with use of Github_Desktop application or for your Terminal/bash.

    For Terminal -

    git clone <url_name>
  3. Upload your Code or Change

    Make what change you want to make in Repo. It can be spelling mistake, code correction or anything.

    You can also upload your program to respective folder. It can be anything "Hello world program", "Rock Paper Scissors",etc.

    All Repository are open for contributions.

  4. Push it and Make a PR

    • Go to the Pull requests section and Click the New pull request button. Create New PR

    • Click the Create pull request to compare your copy of the repo with the real one. Compare PR

    • Write a Title, Leave a comment and click Create New PRbutton to merge the PR.

    merge PR And, that's it!

    New to Open Source? Don't know how to Create a Pull Request? read this documentation.