legacy-libs/walkdir/CONTRIBUTING.md

   1 # walkdir Contributing Guidelines
   2
   3 - Always search for a related issue before starting a new issue.
   4 - Always choose a concise, helpful issue name.
   5 - Always stay on-topic. If you've got a new bug report or feature request, put it in its own issue.
   6 - Always be polite to other people.
   7 - Never post private information, such as torrent or tracker names, IP addresses, etc.
   8
   9 Issues that break the rules may be deleted and locked without warning.
  10
  11 ## walkdir is an OPEN Open Source Project
  12
  13 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.
  14
  15 ## Rules
  16
  17 There are a few basic ground-rules for contributors:
  18
  19 1. **No `--force` pushes** or modifying the Git history in any way.
  20 1. **External API changes and significant modifications** should be subject to a **pull request** to solicit feedback from other contributors.
  21 1. Pull requests to solicit feedback are *encouraged* for any other non-trivial contribution but left to the discretion of the contributor.
  22 1. Use a non-`master` branch for ongoing work.
  23 1. Contributors should attempt to adhere to the prevailing code style.
  24 1. Run `npm test` locally before submitting your PR to catch easy-to-miss style & testing issues
  25
  26 ## Releases
  27
  28 Declaring formal releases remains the prerogative of the project maintainer.
  29
  30 ## Changes to this arrangement
  31
  32 *Thanks to [Rod Vagg](https://github.com/rvagg) and the [LevelUP](https://github.com/rvagg/node-levelup) project for coming up with this model of open source contribution.*