Skip to content

Latest commit

 

History

History
24 lines (16 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

24 lines (16 loc) · 1.33 KB
Raw

Contributing Guidelines

Contributing some changes

  • Fork this repository
  • Make your changes
  • Create a Pull Request from your fork, to the hexnaught/vscode-bitburner-connector repository with develop as the base branch.
  • The PR will be reviewed and either merged or commented on.
    • If the PR has comments, it will remain open until all comments are resolved.
    • The PR will be squashed and merged in to develop

Commit Message Format

If you don't/haven't followed these guidelines, don't worry! I will update the PR title prior to merging your PR.

We are using semantic-release to help automate and version our releases, this relies on commit messages to be in a specific format - We are using the 'Angular' preset, see the Angular Commit Message Guidelines for examples.

We can support custom keywords, these can be seen under the @semantic-release/commit-analyzer releaseRules within .releaserc.

Current Custom Release Rules:

Type Scope SemVer Example
docs README Patch (#.#.X) docs(README): update description for foo