Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 2.18 KB
Raw

Contributing to doil

Contributor Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Basic Workflow

  • Fork the project
  • Add a branch with the number of your issue
  • Develop your feature stuff
  • Commit to your forked project
  • Send a pull request to the develop branch with all the details

Please make sure that you have set up your user name and email address for use with Git. Strings such as silly nick name <root@localhost> look really stupid in the commit history of a project.

Due to time constraints, you may not always get a quick response. Please do not take delays personally and feel free to remind.

Workflow Process

Versioning

Version 1.4.5 of doil will be the last version using the semantic versioning scheme. In future the public version of doil will be named as date of released as described here with this schematic: YYYYMMDD[-PATCH_NUMBER][-RC_NUMBER]

Regarding Issues, PRs, Commits

  • Every issue will be added with the predefined issue forms such as "Improvment" and "Issue Report"
  • Every new issue will be reviewed by the project maintainer. If the issue is approved, it will be assigned certain labels (improvement, bug, ...).
  • Every commit must be linked to the issue with the following pattern: #${ISSUENUMBER}
  • Every PR only contains one commit and one reference to a specific issue

Coding Guidelines

setup

  • We want to implement the google shell styleguide in the long run.
  • doil is using an internal unit testing tool called "tstfy" which handles automated tests. Every developer is required to use it.

app

  • This part of doil is implemented in PHP7.4. We want to accomplish the PSR-12 guidelines.
  • This part of doil is under unit testing. Please ensure to only add php code, which is also under unit testing.