Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Status

Status
colourGreen
titleIncubation

Description


Children Display

Draft Roadmap

draw.io DiagrambordertruediagramNameRte_roadmapsimpleViewerfalsewidthlinksautotbstyletoplboxtruediagramWidth831revision2

Contribution process

  • Create a personal fork of the project on Github

  • Clone the fork on your local machine

  • Make sure to pull upstream changes into your local repository

  • Implement/fix your feature, comment your code if needed

  • Follow the code style of the project, including indentation

  • Run tests on the hardware you want to install the distribution and ensure that no regression are seen (ex: cukinia)

  • Provide the hardware specification

  • Write or adapt tests as needed

  • Add or change the documentation as needed.

  • Squash intermediary commits (fixes, WIP, …) with git's interactive rebase. 

  • Make sure to split your commit

    • Each commit should only add one feature

    • Use two separate commits when adding a package and enabling it

  • Make sure that your commit message is consistent with the git history

    • Prefix the commit title by the area touch 

      • ex: images/seapath-host-common.inc: add STONITH plugins

    • Separate subject from body with a blank line

    • Limit the subject line to 50 characters

    • Use the imperative mood in the subject line

    • Wrap the body at 72 characters

    • Use the body to explain what and why vs. how

More details can be found there.

  • Sign off your commit

  • Push your branch to your fork on Github

  • From your fork open a pull request

Code of conduct

The code of conduct is available here.