Skip to content

create CONTRIBUTING.md #17

Description

@LongLiveCHIEF

Need to have some information and documentation put together for those who want to contribute. A CONTRIBUTING.md file is standard, and will integrate with GitHub and automatically be shown to those opening issues or pull requests.

A CONTRIBUTING.md file typically covers:

  • how to set up a development environment
  • requirements that must be met for a pull request
  • information on how to communication with other collaborators or maintainers
  • any rules or agreements you want contributors to follow
  • how to submit security vulnerability findings privately (this is very important)

GitHub's docs have some good example CONTRIBUTING files

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    questionFurther information is requested

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions