Skip to content

Commit

Permalink
Create HACKTOBERFEST.md (#111)
Browse files Browse the repository at this point in the history
## Related Issue
[Cite any related issue(s) this pull request addresses. If none, simply
state "None”]

## Description
[Please include a brief description of the changes or features added]

## Type of PR

- [ ] Bug fix
- [ ] Feature enhancement
- [x] Documentation update
- [ ] Other (specify): _______________

## Screenshots / videos (if applicable)
[Attach any relevant screenshots or videos demonstrating the changes]

## Checklist:
- [ ] I have performed a self-review of my code
- [ ] I have read and followed the Contribution Guidelines.
- [ ] I have tested the changes thoroughly before submitting this pull
request.
- [ ] I have provided relevant issue numbers, screenshots, and videos
after making the changes.
- [ ] I have commented my code, particularly in hard-to-understand
areas.
<!-- [X] - put a cross/X inside [] to check the box -->

## Additional context:
[Include any additional information or context that might be helpful for
reviewers.]


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Introduced a `HACKTOBERFEST.md` file with guidelines for participating
in Hacktoberfest 2024.
- Provided detailed steps for registration, repository selection, and
contribution criteria.
- Established a seven-day review period for pull requests to ensure
quality contributions.
- Outlined rewards for participants and included resources for further
information.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
  • Loading branch information
aryasoni98 authored Oct 1, 2024
2 parents a7af7d7 + 7e51a6c commit ea161e7
Showing 1 changed file with 92 additions and 0 deletions.
92 changes: 92 additions & 0 deletions HACKTOBERFEST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# Hacktoberfest 2024

Welcome to **Hacktoberfest 2024**! 🎉

Hacktoberfest is a month-long celebration of open-source software, encouraging participation in the open-source community through contributions. Whether you're a seasoned developer or new to coding, your contributions are valuable and welcome.

## How to Participate

1. **Register for Hacktoberfest**: Sign up on the [official Hacktoberfest website](https://hacktoberfest.com) to get started.

2. **Find Repositories**:
- Look for repositories tagged with the `hacktoberfest` topic.
- Contribute to projects that have issues labeled `hacktoberfest-accepted`.
- Ensure the repository is public and not archived.

3. **Make Meaningful Contributions**:
- Your pull/merge requests (PRs/MRs) should add value to the project.
- Avoid trivial changes like fixing typos or formatting.

4. **Submit Your PRs/MRs**:
- PRs/MRs must be created between **October 1 and October 31**.
- They should be accepted by the project's maintainer.

## Contribution Guidelines

- **Quality Over Quantity**: Focus on making meaningful contributions that improve the project.

- **Respect Project Guidelines**: Adhere to the contribution guidelines provided by the project maintainers.

- **Avoid Spam**:
- Do not submit automated or scripted PRs/MRs.
- Refrain from making PRs/MRs that are irrelevant or disruptive.

## Acceptance Criteria

Your PRs/MRs must meet the following criteria to count toward Hacktoberfest:

- **Timing**: Created between October 1 and October 31.

- **Repository**: Contributed to a public, unarchived repository.

- **Approval**:
- **Merged** by a maintainer, **or**
- Labeled as `hacktoberfest-accepted`, **or**
- Given an overall approving review.

- **Status**: Not marked as a draft and not labeled as `spam` or `invalid`.

## Seven-Day Review Period

- After your PR/MR meets the acceptance criteria, it enters a **seven-day review period**.

- During this time, maintainers or Hacktoberfest organizers may invalidate the PR/MR if it doesn't meet the guidelines.

- Once the review period is over and your PR/MR still meets all the checks, it will count toward your Hacktoberfest goals.

## Reducing Spam

To maintain the quality of contributions:

- **Maintainers Can Mark PRs/MRs as Spam**:
- PRs/MRs labeled with `spam` will not be counted.
- Contributors with two or more spammy PRs/MRs may be disqualified.

- **Exclusion of Bad Repositories**:
- Repositories that encourage low-quality contributions will be excluded.
- Such PRs/MRs will not count toward Hacktoberfest.

- **Reporting Issues**:
- If you encounter a repository or PR/MR that goes against Hacktoberfest values, report it to the organizers for review.

## Rewards

- Complete **four valid PRs/MRs** to earn a limited edition Hacktoberfest T-shirt or plant a tree.

- All participants will receive a digital certificate of completion.

## Resources

- **Official Website**: [Hacktoberfest 2024](https://hacktoberfest.com)

- **Event Details**: Learn more about the event, rules, and FAQs.

- **Community Support**: Join the conversation on social media using the hashtag `#Hacktoberfest`.

## Let's Get Started!

Join thousands of developers around the world in making impactful contributions to open-source projects. Happy coding! 🚀

---

*For any questions or clarifications, please refer to the [official Hacktoberfest FAQ](https://hacktoberfest.com/faq) or contact the support team.*

0 comments on commit ea161e7

Please sign in to comment.