Add files for consistent repo structure

nguyer · nguyer · commit 03984cdc1db8 · 2021-08-10T15:33:57.000-04:00
Signed-off-by: Nicko Guyer &lt;nicko.guyer@kaleido.io&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,3 @@
+# Changelog
+
+The changelog will be updated on the next release
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -1,4 +1,4 @@
 # SPDX-License-Identifier: Apache-2.0
 
-# Firefly committers
-* @hyperledger-labs/firefly-committers
+# firefly-cli maintainers
+* @gabriel-indik @peterbroadhurst
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,8 @@
+Code of Conduct Guidelines
+==========================
+
+Please review the Hyperledger [Code of
+Conduct](https://wiki.hyperledger.org/community/hyperledger-project-code-of-conduct)
+before participating. It is important that we keep things civil.
+
+<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,10 @@
+## Contributing
+
+We welcome contributions to the FireFly Project in many forms, and
+there's always plenty to do!
+
+Please visit the
+[contributors guide](https://labs.hyperledger.org/firefly/contributors/contributors.html) in the
+docs to learn how to make contributions to this exciting project.
+
+<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.
diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,3 @@
-
                                  Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
@@ -179,15 +178,15 @@
    APPENDIX: How to apply the Apache License to your work.
 
       To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
+      boilerplate notice, with the fields enclosed by brackets "{}"
       replaced with your own identifying information. (Don't include
       the brackets!)  The text should be enclosed in the appropriate
       comment syntax for the file format. We also recommend that a
       file or class name and description of purpose be included on the
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright {yyyy} {name of copyright owner}
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
diff --git a/MAINTAINERS.md b/MAINTAINERS.md
@@ -0,0 +1,50 @@
+# Maintainers
+
+The following is the list of current maintainers this repo:
+
+| Name             | GitHub          | Email                       | LFID            |
+| ---------------- | --------------- | --------------------------- | --------------- |
+| Gabriel Indik    | gabriel-indik   | gabriel.indik@kaleido.io    | gabriel.indik   |
+| Peter Broadhurst | peterbroadhurst | peter.broadhurst@kaleido.io | peterbroadhurst |
+
+This list is to be kept up to date as maintainers are added or removed.
+
+# Expectations of Maintainers
+
+Maintainers are expected to regularly:
+
+- Make contributions to FireFly code repositories including code or documentation
+- Review pull requests
+- Investigate open GitHub issues
+- Participate in Community Calls
+
+# Becoming a Maintainer
+
+The FireFly Project welcomes and encourages people to become maintainers of the project if they are interested and meet the following criteria:
+
+## Criteria for becoming a member
+
+- Expressed interest and commitment to meet the expectations of a maintainer for at least 6 months
+- A consistent track record of contributions to FireFly code repositories which could be:
+  - Enhancements
+  - Bug fixes
+  - Tests
+  - Documentation
+- A consistent track record of helpful code reviews on FireFly code repositories
+- Regular participation in Community Calls
+- A demonstrated interest and aptitude in thought leadership within the FireFly Project
+- Sponsorship from an existing maintainer
+
+There is no specific quantity of contributions or pull requests, or a specific time period over which the candidate must prove their track record. This will be left up to the discretion of the existing maintainers.
+
+## Process for becoming a maintainer
+
+Once the above criteria have been met, the sponsoring maintainer shall propose the addition of the new maintainer at a public Community Call. Existing maintainers shall vote at the next public Community Call whether the new maintainer should be added or not. Proxy votes may be submitted via email _before_ the meeting. A simple majority of the existing maintainers is required for the vote to pass.
+
+## Maintainer resignation
+
+While maintainers are expected in good faith to be committed to the project for a significant period of time, they are under no binding obligation to do so. Maintainers may resign at any time for any reason. If a maintainer wishes to resign they shall open a pull request to update the maintainers list removing themselves from the list.
+
+## Maintainer inactivity
+
+If a maintainer has remained inactive (not meeting the expectations of a maintainer) for a period of time (at least several months), an email should be sent to that maintainer noting their inactivity and asking if they still wish to be a maintainer. If they continue to be inactive after being notified via email, an existing maintainer may propose to remove the inactive maintainer at a public Community Call. Existing maintainers shall vote at the next public Community Call whether the inactive maintainer should be removed or not. Proxy votes may be submitted via email _before_ the meeting. A simple majority of the existing maintainers is required for the vote to pass.
diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,20 @@
+# Hyperledger Security Policy
+
+## Reporting a Security Bug
+
+If you think you have discovered a security issue in any of the Hyperledger projects, we'd love to
+hear from you. We will take all security bugs seriously and if confirmed upon investigation we will
+patch it within a reasonable amount of time and release a public security bulletin discussing the
+impact and credit the discoverer.
+
+There are two ways to report a security bug. The easiest is to email a description of the flaw and
+any related information (e.g. reproduction steps, version) to
+[security at hyperledger dot org](mailto:security@hyperledger.org).
+
+The other way is to file a confidential security bug in our
+[JIRA bug tracking system](https://jira.hyperledger.org). Be sure to set the “Security Level” to
+“Security issue”.
+
+The process by which the Hyperledger Security Team handles security bugs is documented further in
+our [Defect Response page](https://wiki.hyperledger.org/display/SEC/Defect+Response) on our
+[wiki](https://wiki.hyperledger.org).

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Changelog`
	`2`	`+`
	`3`	`+The changelog will be updated on the next release`