Skip to content

Update pull request templates and implement rulesets on the main branch #642

@ksterne

Description

@ksterne

Documentation

To capture some things that were discussed during the DAWG meeting today, we've got pull request templates (the issue ones seem to be working) in the ~/.github/ directory, but these don't seem to be populating. Github has ways to protect the main branch with rulesets as well.

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

Similar to #641, it seems as though there issue templates that are being populated, but there are not ones for pull requests. Having pull request templates will help new developers/contributors to making a good pull request from the start. There are templates in ~/.github/PULL_REQUEST_TEMPLATE/ but these haven't been updated in 3 to 5 years, so maybe there is something that needs to be changed for Github to recognize them whenever someone makes a pull request.

Related to this, some of the admins for the rst repo should be able to implement some rules to prevent merging into main under the "Settings/Rules/Ruleset" options. Github has some documentation on rulesets.

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