das-labor / panopticon

A libre cross-platform disassembler.
https://panopticon.re
GNU General Public License v3.0
1.43k stars 78 forks source link

Add development guidelines to README #270

Closed flanfly closed 7 years ago

flanfly commented 7 years ago

For contributors

  1. Please have fun, nobody is paid for developing Panopticon.
  2. Everything is up to debate, none of the following guidelines is set in stone.
  3. I you want to help, check out the easy issues.
  4. If you want a feature, open an issue before you're dumping your 5k line patch, small bug fixes are ok.
  5. Format w/ rust-fmt before submitting.
  6. Please add tests, at least one positive and one negative test. Make sure the coverage doesn't decrease.
  7. Consider splitting your change into multiple smaller ones.
  8. All CI jobs must pass. You have an infinite amount of tries.

For maintainers & reviewers

  1. Assume good faith.
  2. Please have fun, nobody is paid for developing Panopticon.
  3. Everything is up to debate, none of the following guidelines is set in stone.
  4. Check whenever contributed code:
    1. scales reasonable well,
    2. has no (obvious) security problems,
    3. isn't reimplementing features that exist in Panopticon already,
    4. is in the right place,
    5. comes w/ unit tests that demonstrate the code works and make sure it can be changed later,
    6. includes legible documentation.
      1. No bikeshedding about naming, brace placement, argument order, "taste" or "style".
      2. If in doubt, merge. (EDIT)
      3. Please thank the contributor. It costs nothing. Also, see 2.

/cc @m4b @sphinxc0re Part of #267

sphinxc0re commented 7 years ago

Usually, contribution guidelines belong into the CONTRIBUTING.md file, not in the README.md

flanfly commented 7 years ago

Yeah, it got a bit long :joy:

sphinxc0re commented 7 years ago

Other than that, this looks really good.

EDIT: Also there are a few spelling and punctuation errors in your text

m4b commented 7 years ago

LGTM.

Also this made me lol:

You have an infinite amount of tries.