Skip to content

Commit 031de72

Browse files
authored
Merge pull request #47 from didx-xyz/Kentoseth-patch-1
Adding Contribution guidelines and Security policy
2 parents 5013d7a + 998fa16 commit 031de72

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## How to contribute
2+
3+
You are encouraged to contribute to the repository by **forking the repo, making your changes and then submitting a pull request back to this repo**.
4+
5+
For significant changes, please open an issue first to discuss the proposed changes to avoid re-work.
6+
7+
(If you are new to GitHub, you might start with a [basic tutorial](https://help.github.com/articles/set-up-git), how to [fork a repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo) and check out a more detailed guide to [pull requests](https://help.github.com/articles/using-pull-requests/).)
8+
9+
Pull requests will be evaluated by the respective repo maintainers on a schedule and if deemed beneficial, will be committed to the `main` branch. Pull requests should have a descriptive name, include a summary of all changes made in the pull request description and include unit tests that provide good coverage of the feature or fix. A Continuous Integration (CI) pipeline is executed on all PRs before review and contributors are expected to address all CI issues identified. Where appropriate, PRs that impact the end-user and developer demos in the repo should include updates or extensions to those demos to cover the new capabilities.
10+
11+
All contributors retain the original copyright to their stuff, but by contributing to this project, you grant a world-wide, royalty-free, perpetual, irrevocable, non-exclusive, transferable license to all users **under the terms of the [license](./LICENSE) under which this project is distributed.**

SECURITY.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Yoma Security Policy
2+
3+
## Reporting a Security Bug
4+
5+
If you think you have discovered a security issue in any of the Yoma projects, we'd love to
6+
hear from you. We will take all security bugs seriously and if confirmed upon investigation we will
7+
patch it within a reasonable amount of time and release a public security announcement discussing the
8+
bug and credit the discoverer.
9+
10+
Security bugs can be reported via email. The process is as follows:
11+
12+
(email) Subject: Security Issue: [repo-name] - [Type of bug]
13+
14+
(email) Content: Description of the bug + how to reproduce the bug
15+
16+
Email Yoma at: [tech at yoma dot world](mailto:tech@yoma.world).
17+
18+
*Note. It is not necessary to include the type of bug if you are not sure how to classify it.*
19+
*A detailed description will be adequate.*

0 commit comments

Comments
 (0)