Skip to content

Latest commit

 

History

History
120 lines (83 loc) · 3.96 KB

CONTRIBUTING.md

File metadata and controls

120 lines (83 loc) · 3.96 KB
Raw

Contributing to RelayServer

We would love for you to contribute to RelayServer and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:

Coding Rules

To ensure consistency throughout the source code, keep these rules in mind as you are working:

  • All public API methods must be documented.
  • TBD

Commit Message Guidelines

We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history.

Commit Message Format

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

The header is mandatory and the scope of the header is optional.

Any line of the commit message cannot be longer than 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.

The footer should contain a closing reference to an issue if any.

Samples:

docs(changelog): update changelog to beta.5

fix(release): need to depend on latest rxjs and zone.js

The version in our package.json gets copied to the one we publish, and users need the latest of these.

Revert

If the commit reverts a previous commit, it should begin with revert: , followed by the header of the reverted commit. In the body it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.

Type

Must be one of the following:

  • build: Changes that affect the build system or external dependencies (example scopes: npm, dotnet, packaging)
  • ci: Changes to our CI configuration files and scripts (example scopes: TBD)
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • chore: used for maintaining IDE settings, etc.

Scope

The scope should be the name of the npm package or namespace affected (as perceived by the person reading the changelog generated from commit messages).

The following is the list of supported scopes:

  • abstractions
  • connector
  • connector-abstractions
  • docker
  • persistence
  • server
  • server-abstractions
  • management
  • statistics
  • interceptor
  • protocols

There are currently a few exceptions to the "use package name" rule:

  • packaging: used for changes that change the npm or NuGet package layout, e.g. public path changes, package.json changes, d.ts file/format changes, changes to bundles, etc.
  • changelog: used for updating the release notes in CHANGELOG.md
  • contributing: used for updating the notes in CONTRIBUTING.md

Subject

The subject contains a succinct description of the change:

  • use the imperative, present tense: "change" not "changed" nor "changes"
  • don't capitalize the first letter
  • no dot (.) at the end

Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.

Footer

The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.

Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.

A detailed explanation can be found in this [document][commit-message-format].