Skip to content

Commit

Permalink
gh-200: update CONTRIBUTING.md to follow new title convention (#218)
Browse files Browse the repository at this point in the history
The CONTRIBUTING guideline should reflect the recent change in PR title
convention.

Ref: #200
  • Loading branch information
Saransh-cpp committed Sep 17, 2024
1 parent 12f3265 commit 49e39ef
Showing 1 changed file with 1 addition and 24 deletions.
25 changes: 1 addition & 24 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,30 +21,7 @@ Pull requests

Pull requests to the `main` branch should have titles of the following form:

TYPE: Subject line

The title can optionally refer to the module which is being changed:

TYPE(module): Subject line

The `TYPE` prefix should indicate the nature of the change and must be taken
from the following list:

API -- an (incompatible) API change
BUG -- bug fix
DEP -- deprecate something, or remove a deprecated object
DEV -- development infrastructure (tools, packaging, etc.)
DOC -- documentation
ENH -- enhancement
MNT -- maintenance commit (refactoring, typos, etc.)
REV -- revert an earlier commit
STY -- style fix (whitespace, PEP8)
TST -- addition or modification of tests
TYP -- static typing
REL -- related to releasing GLASS

The optional `module` tag should indicate which modules are affected by the
change, and refer to an existing module name.
gh-<issue-number>: Subject line

The body of the pull request should contain a description of the changes, and
any relevant details or caveats of the implementation.
Expand Down

0 comments on commit 49e39ef

Please sign in to comment.