Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
45 lines (29 sloc) 1.85 KB

documentation 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

There are a few basic ground-rules for contributors:

  1. No --force pushes or modifying the Git history in any way.
  2. Non-master branches ought to be used for ongoing work.
  3. External API changes and significant modifications ought to be subject to an internal pull-request to solicit feedback from other contributors.
  4. Internal pull-requests to solicit feedback are encouraged for any other non-trivial contribution but left to the discretion of the contributor.
  5. Contributors should attempt to adhere to the prevailing code-style.

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.

this approach is totally cribbed from the excellent LevelUP project


Releasing

documentation aims to release often. We use standard-changelog to generate CHANGELOG.md entries and commitizen to standardize commit messages. Pull Request messages should be standardized to commitizen syntax (aka angular standard) before merge.

Release process:

  • Confirm that master passes CI tests
  • Bump version in package.json
  • Run npm run changelog
  • Add updated CHANGELOG.md to master
  • Push commits
  • npm publish
You can’t perform that action at this time.