Skip to content

Latest commit

 

History

History
16 lines (14 loc) · 1.8 KB

SUBMISSION_GUIDELINES.md

File metadata and controls

16 lines (14 loc) · 1.8 KB

Fiveable Open Source Project Submission Guidelines

  • Projects must be constructive and unique, repos that are intended to serve as a personal website or documentation websites are not allowed. The exception to this are external guides for libraries that don't provide a guide.
  • Projects must have a clear CODE_OF_CONDUCT.md that clearly denounces any discriminatory, unwelcoming, or any otherwise harmful behavior that damages/hinders the positive environment we've strived to create. Examples of an acceptable code of conduct can be found at contributor-covenant.org/version/2/0/code_of_conduct.
  • Projects must have a clear/organized README with information as to what the projects purpose is. It doesn't have to be a fancy readme, but it does need to cover basic information.
    • repo description
    • clear instructions as to how to setup a local environment for contributors
    • (encouraged) gifs/photos/text demonstrating example usage
    • (encouraged) demo
    • repo structure explanation (if isn't self-explanatory)
  • Projects must be contributable, cannot be archived or privated, and must be licensed under an appropriate license that is Open Source foundation certified. You can find an abiding license at (https://choosealicense.com/).
  • Projects must be submitted by either the repo owner or someone with the "maintainer" status on said repo. "contributor" status does not meet this criteria.
  • Submitter/maintainers must display behavior that will fit well with our environment. Toxic or unwelcoming behavior is not tolerated at all.
  • If the project is a fork, it must be transformative to an extent. This will be decided on a case by case basis.

If any help is needed with the overall application process or repository setup, you can contact the Open Source Interns at the Discord server.