Skip to content

Commit 8d19aba

Browse files
author
Andreas Fuchs
committed
Added CHANGELOG and CONTRIBUTING
Signed-off-by: Andreas Fuchs <[email protected]>
1 parent baf9513 commit 8d19aba

File tree

3 files changed

+44
-0
lines changed

3 files changed

+44
-0
lines changed

CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Change Log
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](http://keepachangelog.com/)
5+
6+
## [0.0.x] - 2018-10-XX
7+
Initial pre-release
8+
### Added
9+
- The engine itself with command-line tool
10+
### Removed
11+
- Initial PEM file storage format

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Guidelines for submitting bugs:
2+
All non security bugs should be filed on the Issues tracker:
3+
https://github.com/tpm2-software/tpm2-tss-engine/issues
4+
5+
Security sensitive bugs should be emailed to a maintainers directly.
6+
7+
# Guideline for submitting changes:
8+
All changes to the source code must follow the coding standard used in the
9+
tpm2-tss project [here](https://github.com/tpm2-software/tpm2-tss/blob/master/doc/coding_standard_c.md).
10+
11+
All changes should be introduced via github pull requests. This allows anyone to
12+
comment and provide feedback in lieu of having a mailing list. For pull requests
13+
opened by non-maintainers, any maintainer may review and merge that pull
14+
request. For maintainers, they either must have their pull request reviewed by
15+
another maintainer if possible, or leave the PR open for at least 24 hours, we
16+
consider this the window for comments.
17+
18+
## Patch requirements
19+
* All tests must pass on Travis CI for the merge to occur.
20+
* All changes must not introduce superfluous changes or whitespace errors.
21+
* All commits should adhere to the git commit message guidelines described
22+
here: https://chris.beams.io/posts/git-commit/ with the following exceptions.
23+
* We allow commit subject lines up to 80 characters.
24+
* All contributions must adhere to the Developers Certificate of Origin. The
25+
full text of the DCO is here: https://developercertificate.org/. Contributors
26+
must add a 'Signed-off-by' line to their commits. This indicates the
27+
submitters acceptance of the DCO.
28+
29+
## Guideline for merging changes
30+
Changes must be merged with the "rebase" option on github to avoid merge
31+
commits. This provides for a clear linear history.

Makefile.am

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,8 @@ EXTRA_DIST += $(TESTS)
108108

109109
# Adding user and developer information
110110
EXTRA_DIST += \
111+
CHANGELOG.md \
112+
CONTRIBUTING.md \
111113
INSTALL.md \
112114
LICENSE \
113115
README.md

0 commit comments

Comments
 (0)