Skip to content

Latest commit

 

History

History
36 lines (26 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

36 lines (26 loc) · 2.47 KB
Raw

Contributing to uplink

If you have loved using uplink and want to give back, we would love to have you open GitHub issues and PRs for features, bugs and documentation improvements.

We try to follow a regular release cycle, with releases versioned in semver, maintaining a Changelog where changes are tracked and included within the PR whenever the changes are made. PRs shall only be squash merged with a well written commit message having a format similar to the Conventional Commits to better describe the changes and their relevance. The message format convention we shall use is as follows:

<Tag>(<Component>): <Title>

[BREAKING:]

<Body>

Signed off: <Contributor>

[Issue:]

Attribute:

Squash Commit Message Convention

  • Tags are used to describe the type of commit(e.g: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test:).
  • The optional use of Component describes the module or specific component to which changes included in the commit are associated with.
  • Title contains a brief description of the changes included in the commit, a single line summary.
  • An optional BREAKING label could also be included with a message describing the change that is breaking an API exposed by the project.
  • A compulsory Body must contain the descriptive explanation of the changes made within the commit and include any reasonings as to why they were included.
  • A further section Signed off: will denote that the assoicated contributors have signed-off the code contained in the commit.
  • An optional Issue section could describe any GitHub Issue associated with the commit.
  • Attribute section is used to tag contributors to the PR.

uplink is licensed under the permissive Apache License Version 2.0 and we accept contributions under the implied notion that they are made in complete renunciation of the contributors any rights or claims to the same after the code has been merged into the codebase.

Please make yourself familiar with the construction of uplink and read the design docs before making your first contribution to increase it's chances of being adopted. Please follow the Code of Conduct when communicating with other members of the community and keep discussions civil, we are excited to have you make your first of many contributiions to this repository, welcome!