31 lines
1.5 KiB
Markdown
31 lines
1.5 KiB
Markdown
# Pino is an OPEN Open Source Project
|
|
|
|
## What?
|
|
|
|
Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.
|
|
|
|
## Rules
|
|
|
|
Before you start coding, please read [Contributing to projects with git](https://jrfom.com/posts/2017/03/08/a-primer-on-contributing-to-projects-with-git/).
|
|
|
|
Notice that as long as you don't have commit-access to the project, you have to fork the project and open PRs from the feature branches of the forked project.
|
|
|
|
There are a few basic ground-rules for contributors:
|
|
|
|
1. **No `--force` pushes** on `master` or modifying the Git history in any way after a PR has been merged.
|
|
1. **Non-master branches** ought to be used for ongoing work.
|
|
1. **Non-trivial changes** ought to be subject to an **internal pull-request** to solicit feedback from other contributors.
|
|
1. All pull-requests for new features **must** target the `master` branch. PRs to fix bugs in LTS releases are also allowed.
|
|
1. Contributors should attempt to adhere to the prevailing code-style.
|
|
1. 100% code coverage
|
|
|
|
## Releases
|
|
|
|
Declaring formal releases remains the prerogative of the project maintainer.
|
|
|
|
## Changes to this arrangement
|
|
|
|
This is an experiment and feedback is welcome! This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change.
|
|
|
|
-----------------------------------------
|