From 8d19aba2ff521f7dadd89903c3f688d0bbad64b9 Mon Sep 17 00:00:00 2001 From: Andreas Fuchs Date: Thu, 18 Oct 2018 10:46:10 +0200 Subject: [PATCH] Added CHANGELOG and CONTRIBUTING Signed-off-by: Andreas Fuchs --- CHANGELOG.md | 11 +++++++++++ CONTRIBUTING.md | 31 +++++++++++++++++++++++++++++++ Makefile.am | 2 ++ 3 files changed, 44 insertions(+) create mode 100644 CHANGELOG.md create mode 100644 CONTRIBUTING.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..ca48e34 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,11 @@ +# Change Log +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/) + +## [0.0.x] - 2018-10-XX +Initial pre-release +### Added +- The engine itself with command-line tool +### Removed +- Initial PEM file storage format diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..05bc8c2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Guidelines for submitting bugs: +All non security bugs should be filed on the Issues tracker: +https://github.com/tpm2-software/tpm2-tss-engine/issues + +Security sensitive bugs should be emailed to a maintainers directly. + +# Guideline for submitting changes: +All changes to the source code must follow the coding standard used in the +tpm2-tss project [here](https://github.com/tpm2-software/tpm2-tss/blob/master/doc/coding_standard_c.md). + +All changes should be introduced via github pull requests. This allows anyone to +comment and provide feedback in lieu of having a mailing list. For pull requests +opened by non-maintainers, any maintainer may review and merge that pull +request. For maintainers, they either must have their pull request reviewed by +another maintainer if possible, or leave the PR open for at least 24 hours, we +consider this the window for comments. + +## Patch requirements +* All tests must pass on Travis CI for the merge to occur. +* All changes must not introduce superfluous changes or whitespace errors. +* All commits should adhere to the git commit message guidelines described +here: https://chris.beams.io/posts/git-commit/ with the following exceptions. + * We allow commit subject lines up to 80 characters. +* All contributions must adhere to the Developers Certificate of Origin. The +full text of the DCO is here: https://developercertificate.org/. Contributors +must add a 'Signed-off-by' line to their commits. This indicates the +submitters acceptance of the DCO. + +## Guideline for merging changes +Changes must be merged with the "rebase" option on github to avoid merge +commits. This provides for a clear linear history. diff --git a/Makefile.am b/Makefile.am index cc123bd..1bd0f7d 100644 --- a/Makefile.am +++ b/Makefile.am @@ -108,6 +108,8 @@ EXTRA_DIST += $(TESTS) # Adding user and developer information EXTRA_DIST += \ + CHANGELOG.md \ + CONTRIBUTING.md \ INSTALL.md \ LICENSE \ README.md