Skip to content

Latest commit

 

History

History
30 lines (23 loc) · 1.23 KB

File metadata and controls

30 lines (23 loc) · 1.23 KB

How to contribute

Mindset

This repository is to share code from the Shom’s PING project to the open source community. Contributions can be of different sorts:

  • Sharing ideas of new features
  • Sharing new code for new features
  • reporting a bug and, if applicable, suggest and share a fix

Discussion means

  • One can open a discussions topic to share its ideas, ask its questions. enter image description here
  • One can open an issue if the discussion concerns code (already developped or to be developped). enter image description here

Technically

Only Shom's employees are allowed to modify the repository, however one can contribute by working on a fork of this current repository. enter image description here

Conventions

Fork the repository and make changes on your fork in a feature branch:

  • If it's a bug fix branch, name it XXXX-something where XXXX is the number of the issue.
  • If it's a feature branch, create an enhancement issue to announce your intentions, and name it XXXX-something where XXXX is the number of the issue.

Contribution best practice

Coding Style

Semantic versioning

https://semver.org/