Skip to content

Latest commit

 

History

History
81 lines (66 loc) · 4.42 KB

contribution.md

File metadata and controls

81 lines (66 loc) · 4.42 KB
Raw

Contribution Guidelines

==================

Overview

Being an Open Source project, everyone can contribute, provided that it respect the following points:

  • Before contributing any code, the author must make sure all the tests work (see below how to launch the tests).
  • Developed code must adhere to the syntax guidelines enforced by the linters.
  • Code must be developed following the branching model and changelog policies defined below.
  • For any new feature added, unit tests must be provided, following the example of the ones already created.

In order to start contributing:

  1. Fork this repository clicking on the "Fork" button on the upper-right area of the page.
  2. Clone your just forked repository:
git clone https://github.com/your-github-username/lightweightm2m-iotagent.git
  1. Add the main lightweightm2m-iotagent repository as a remote to your forked repository (use any name for your remote repository, it does not have to be lightweightm2m-iotagent, although we will use it in the next steps):
git remote add lightweightm2m-iotagent https://github.com/telefonicaid/lightweightm2m-iotagent.git

Before starting contributing, remember to synchronize the develop branch in your forked repository with the develop branch in the main lightweightm2m-iotagent repository, by following this steps

  1. Change to your local develop branch (in case you are not in it already):
  git checkout develop
  1. Fetch the remote changes:
  git fetch lightweightm2m-iotagent
  1. Merge them:
  git rebase lightweightm2m-iotagent/develop

Contributions following this guidelines will be added to the develop branch, and released in the next version. The release process is explaind in the Releasing section below.

Branching model

There are two special branches in the repository:

  • master: holds the code for the last stable version of the project. It is only updated when a new version is released, and its always updated with the current state of develop.
  • develop: contains the last stable development code. New features and bug fixes are always merged to develop.

In order to start developing a new feature or refactoring, a new branch should be created with name task/<taskName>. This branch must be created from the current version of the develop branch. Once the new functionality has been completed, a Pull Request will be created from the feature branch to develop. Remember to check both the linters and the tests before creating the Pull Request.

Bug fixes work the same way as other tasks, with the exception of the branch name, that should be called bug/<bugName>.

In order to contribute to the repository, these same scheme should be replicated in the forked repositories, so the new features or fixes should all come from the current version of develop and end up in develop again.

All the task/* and bug/* branches are temporary, and should be removed once they have been merged.

There is another set of branches called release/<versionNumber>, one for each version of the product. This branches point to each of the released versions of the project, they are permanent and they are created with each release.

Changelog

The project contains a version changelog, called CHANGES_NEXT_RELEASE, that can be found in the root of the project. Whenever a new feature or bug fix is going to be merged with develop, a new entry should be added to this changelog. The new entry should contain the reference number of the issue it is solving (if any).

When a new version is released, the changelog is cleared, and remains fixed in the last commit of that version. The content of the changelog is also moved to the release description in the Github release.

Releasing

The process of making a release consists of the following steps:

  1. Create a new task branch changing the development version number in the package.json (with a sufix -next), to the new target version (without any sufix), and PR into develop.
  2. Create a tag from the last version of develop named with the version number and push it to the repository.
  3. Create the release in Github, from the created tag. In the description, add the contents of the Changelog.
  4. Create a release branch from the last version of develop named with the version number.
  5. PR develop into master.
  6. Create a new task for preparing the next release, adding the sufix -next to the current version number (to signal this as the development version).