Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 4.1 KB

CONTRIBUTING.md

File metadata and controls

64 lines (45 loc) · 4.1 KB
Raw

CONTRIBUTORS Guide

How to get started?

The easiest way to start is to look at existing issues and see if there’s something there that you’d like to work on. You can filter issues with the label “Good first issue” which are relatively self sufficient issues and great for first time contributors.

Once you decide on an issue, please comment on it so that all of us know that you’re on it.

If you’re looking to add a new feature, raise a new issue and start a discussion with the community. Engage with the maintainers of the project and work your way through.

You'll need to perform the following tasks in order to submit your changes:

  • Fork the repository.
  • Create a branch for your changes.
    • In case if you're picking up an issue, thenname your branch corresponds to an issue_id
  • Add commits to that branch.
  • Open a PR and choose your branch_name to share your contribution.

HERE’S WHAT YOU NEED TO KNOW TO PARTICIPATE AND COMPLETE HACKTOBERFEST:

  • Register anytime between September 26 and October 31

  • Pull requests can be made in any GITHUB (or GITLAB) hosted project that’s participating in Hacktoberfest (look for the “hacktoberfest” topic)

  • Project maintainers must accept your pull/merge requests for them to count toward your total

  • Have 4 pull/merge requests accepted between October 1 and October 31 to complete Hacktoberfest

  • The first 40,000 participants (maintainers and contributors) who complete Hacktoberfest can elect to receive one of two prizes: a tree planted in their name, or the Hacktoberfest 2022 t-shirt.

PULL/MERGE REQUEST DETAILS

HERE’S HOW WE VALIDATE CONTRIBUTOR PULL/MERGE REQUESTS (“PR/MRS”) FOR HACKTOBERFEST

[ OUT-OF-BOUNDS ]

  • YOUR PR/MRS MUST BE WITHIN THE BOUNDS OF HACKTOBERFEST.
  • Your PR/MRs must be created between October 1 and October 31 (in any time zone, UTC-12 thru UTC+14).
  • Your PR/MRs must be made to a public, unarchived repository.

[ SPAM ]

  • YOUR PR/MRS MUST NOT BE SPAMMY.
  • PR/MRs that are labeled with a label containing the word “spam” by maintainers will not be counted.
    • PR/MRs that also have the “hacktoberfest-accepted” label cannot be marked as spammy via a label.
    • PR/MRs that have been merged and do not have a label containing the word “invalid” cannot be marked as spammy via a label.
    • PR/MRs that our system detects as spammy will also not be counted.
  • Any user with two or more spammy PR/MRs will be disqualified.

[ PARTICIPATING ]

  • YOUR PR/MRS MUST BE IN A REPO TAGGED WITH THE “HACKTOBERFEST” TOPIC, OR HAVE THE “HACKTOBERFEST-ACCEPTED” LABEL.
  • Hacktoberfest is now opt-in for maintainers, so only contribute to projects that indicate they’re looking for Hacktoberfest PR/MRs.
  • Once your PR/MR has passed this check, we won’t check this again (unless your PR/MR fails a check before this, such as it being marked as spammy).

[ INVALID ]

  • YOUR PR/MRS MUST NOT BE LABELED AS “INVALID”.
  • PR/MRs that have a label containing the word “invalid” won’t be counted, unless they also have the “hacktoberfest-accepted” label.
  • Specifically, we use the Node.js 16 RegEx engine with /\binvalid\b/i to look for invalid labels.

[ ACCEPTED ]

  • YOUR PR/MRS MUST BE MERGED, HAVE THE “HACKTOBERFEST-ACCEPTED” LABEL, OR HAVE AN OVERALL APPROVING REVIEW.
  • Your PR/MR must not be a draft to be considered accepted.
  • If your PR/MR is being accepted for Hacktoberfest via an overall approving review it must also not be closed.
  • ONCE YOUR PR/MRS PASS ALL THE CHECKS ABOVE, IT WILL BE ACCEPTED FOR HACKTOBERFEST AFTER THE 7-DAY REVIEW PERIOD.
  • We continually evaluate all of the checks except the [PARTICIPATING] check. If it fails any of these checks during this time, the 7-day timer will reset.
  • After the 7-day review period completes, your PR/MR will be automatically accepted for Hacktoberfest assuming it still passes all the checks. Once accepted for Hacktoberfest, we stop checking. :party: