diff options
| author | Joseph Richey <joerichey@google.com> | 2017-08-29 16:53:16 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-08-29 16:53:16 -0700 |
| commit | b7f0e79d7a1dc4ff196d59e19a665a346082b542 (patch) | |
| tree | f997bb4a9e234d6feed3d23a69899a097ec743a4 | |
| parent | 18de9247683c5c49f5a0001723baa33f6025d55d (diff) | |
| parent | b015bad25caa7bb36058da351aae5eb96fa3ef9f (diff) | |
Merge pull request #48 from google/contrib
Update CONTRIBUTING.md to explain how issues will work
| -rw-r--r-- | CONTRIBUTING.md | 37 |
1 files changed, 30 insertions, 7 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 357661c..c74f0be 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,15 +15,38 @@ You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again. -## Reporting an Issue +## Reporting an Issue or Discussing Design -Any bugs or problems found in fscrypt should be reported though the -[Github Issue Tracker](https://github.com/google/fscrypt/issues/new). When -reporting an issue, be sure to give as much information about the problem as -possible. If reporting an issue around the fscrypt command-line tool, post the +__IMPORTANT__: Any significant security issues should __NOT__ be reported in +the public issue tracker. Practice responsible disclosure by emailing +<joerichey@google.com> and <tyhicks@canonical.com> directly. + +Any bugs, problems, or design discussion relating to fscrypt should be rasied +in the [Github Issue Tracker](https://github.com/google/fscrypt/issues/new). + +When reporting an issue or problem, be sure to give as much information as +possible. Also, make sure you are running the `fscrypt` and `pam_fscrypt` +built from the current `master` branch. + +If reporting an issue around the fscrypt command-line tool, post the relevant output from fscrypt, running with the `--verbose` flag. For the -pam_fscrypt module, use the `debug` option with the module and post the relevant -parts of the syslog (usually at `/var/log/syslog`). +`pam_fscrypt` module, use the `debug` option with the module and post the +relevant parts of the syslog (usually at `/var/log/syslog`). + +Be sure to correctly tag your issue. The usage for the tags is as follows: +* `bug` - General problems with the program's behavior + * The program crashes or hangs + * Directories cannot be locked/unlocked + * Metadata corruption + * Data loss/corruption +* `documentation` + * Typos or unclear explanations in `README.md` or man pages. + * Outdated example output + * Unclear or ambiguous error messages +* `enhancement` - Things you want in fscrypt +* `question` - You don't know how something works with fscrypt + * This usally turns into a `documentation` issue. +* `testing` - Strange test failures or missing tests ## Code reviews |