Skip to content

Latest commit

 

History

History
45 lines (38 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

45 lines (38 loc) · 2.39 KB

How to Contribute

  • Fork this repo.
  • Clone the forked repo.
  • Make changes to the code.
  • Commit the changes.
  • Push the changes to the forked repo.
  • Create a pull request.
  • and done...will be reviewed soon.

Hacktoberfest 2022

  • This repository is actively accepting contributions to hacktoberfest 2022
  • For a contribution to count towards hacktoberfest it must be significant:
    • For a README.md contribution to count it must be more than two paragraphs and contain significant information about the project
    • Programming contributions should solve at least one file or one function and be more than 10 lines of code
    • Contributions that solve an existing issue will also be accepted as long as the issue is more than just a typo

For Beginners:

  • Fork this repo
  • Look over the repository and find an area you would like to work on
    • a good first project would be to pick an incomplete function to work on within project.
    • a good first documentation project would be good to go contribute 2+ paragraphs and a diagram or 3+ paragraphs without a diagram
  • Once you have decided what you would like to work on create comments within the code outlining your chosen contribution
    • If you picked a function to work on create comments with basic pseudocode describing how you will solve the problem or if applicable modify existing pseudocode.

    • For documentation create a comment in the README.md file with your overall topic and a comment on what each paragraph will focus on

    • For any section in the code you would like to work on create a comment indicating you plan on working on that section.

  • Submit a pull request
  • Your pull request will not be approved yet but we will be able to comment on your pseudocode or documentation outline to give you guidance and will know what you are working on so no one else works on it
  • Complete your contribution
  • Comment and let us know you have completed your contribution
  • and done... will be reviewed soon

For More Experienced Contributors:

  • Fork this repo.
  • Clone the forked repo.
  • Make changes to the code such as a new function, finishing existing functions and/or contributing information to the README.md
  • Commit the changes.
  • Push the changes to the forked repo.
  • Create a pull request.
  • and done...will be reviewed soon.