www.aleph1.co.uk Git - yaffs-website/blob - node_modules/min-document/CONTRIBUTION.md

   1 # This is an OPEN Open Source Project
   2
   3 ## What?
   4
   5 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.
   6
   7 ## Rules
   8
   9 There are a few basic ground-rules for contributors:
  10
  11  - No --force pushes or modifying the Git history in any way.
  12  - Non-master branches ought to be used for ongoing work.
  13  - External API changes and significant modifications ought to be subject to an internal pull-request to solicit feedback from other contributors.
  14  - Internal pull-requests to solicit feedback are encouraged for any other non-trivial contribution but left to the discretion of the contributor.
  15  - For significant changes wait a full 24 hours before merging so that active contributors who are distributed throughout the world have a chance to weigh in.
  16  - Contributors should attempt to adhere to the prevailing code-style.
  17 Releases
  18
  19 Declaring formal releases requires peer review.
  20
  21  - A reviewer of a pull request should recommend a new version number (patch, minor or major).
  22  - Once your change is merged feel free to bump the version as recommended by the reviewer.
  23  - A new version number should not be cut without peer review unless done by the project maintainer.
  24
  25 ## Want to contribute?
  26
  27 Even though collaborators may contribute as they see fit, if you are not sure what to do, here's a suggested process:
  28
  29 ## Cutting a new version
  30
  31  - Get your branch merged on master
  32  - Run `npm version major` or `npm version minor` or `npm version patch`
  33  - `git push origin master --tags`
  34  - If you are a project owner, then `npm publish`
  35
  36 ## If you want to have a bug fixed or a feature added:
  37
  38  - Check open issues for what you want.
  39  - If there is an open issue, comment on it, otherwise open an issue describing your bug or feature with use cases.
  40  - Discussion happens on the issue about how to solve your problem.
  41  - You or a core contributor opens a pull request solving the issue with tests and documentation.
  42  - The pull requests gets reviewed and then merged.
  43  - A new release version get's cut.
  44  - (Disclaimer: Your feature might get rejected.)
  45
  46 ### Changes to this arrangement
  47
  48 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.