Skip to content

Add contributor guidelines to the GitHub repository #641

@aburrell

Description

@aburrell

Documentation

Add a CONTRIBUTING.md file to the GitHub repository, which describes our review process and what steps to take when creating a pull request.

Purpose

  • update
  • new
  • remove
  • typo/grammar change
  • formatting improvement

Category

  • code documentation
  • wiki
  • README
  • installation guide
    • OS specifics
    • dependency
  • data products information
  • tutorials
    • plotting
    • io
    • data products
  • examples
  • citing/licensing
  • troubleshooting
    • installation
    • tutorials
  • history
  • guidelines
    • developer
    • communication
    • release

Details

When we have a first-time or first-in-a-long-time contributor, they may not know the correct process to follow and could make mistakes that slow down testing and adaptation. It would be helpful to have a place in the repository with a standard name that people can find and reference.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions