Skip to content

Commit 399ce08

Browse files
ayomideadeniranBot
andauthored
docs: add Contributor Covenant v2.1, SECURITY.md, and README pointers (#24)
* security: add SECURITY.md with vulnerability disclosure policy Closes #5 * docs: add CODE_OF_CONDUCT.md and reference in README --------- Co-authored-by: Bot <bot@example.com>
1 parent f7056ba commit 399ce08

3 files changed

Lines changed: 132 additions & 0 deletions

File tree

CODE_OF_CONDUCT.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
* Demonstrating empathy and kindness toward other people
14+
* Being respectful of differing opinions, viewpoints, and experiences
15+
* Giving and gracefully accepting constructive feedback
16+
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
* Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
21+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
22+
* Trolling, insulting or derogatory comments, and personal or political attacks
23+
* Public or private harassment
24+
* Publishing others' private information, such as a physical or email address, without their explicit permission
25+
* Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement Responsibilities
28+
29+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
32+
33+
## Scope
34+
35+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
36+
37+
## Enforcement
38+
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at maintainers@apexchainx.com. All complaints will be reviewed and investigated promptly and fairly.
40+
41+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
42+
43+
## Enforcement Guidelines
44+
45+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
46+
47+
### 1. Correction
48+
49+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
50+
51+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
52+
53+
### 2. Warning
54+
55+
**Community Impact**: A violation through a single incident or series of actions.
56+
57+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
58+
59+
### 3. Temporary Ban
60+
61+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
62+
63+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
64+
65+
### 4. Permanent Ban
66+
67+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
68+
69+
**Consequence**: A permanent ban from any sort of public interaction within the community.
70+
71+
## Attribution
72+
73+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
74+
75+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
76+
77+
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
78+
79+
[homepage]: https://www.contributor-covenant.org
80+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
81+
[Mozilla CoC]: https://github.com/mozilla/diversity
82+
[FAQ]: https://www.contributor-covenant.org/faq
83+
[translations]: https://www.contributor-covenant.org/translations

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,7 @@ apexchainx-contracts/
183183
├── CONTRIBUTING.md
184184
├── CHANGELOG.md
185185
├── README.md
186+
├── SECURITY.md
186187
├── TODO.md
187188
└── pers-store/ # Persistent storage test fixtures
188189
```
@@ -474,8 +475,14 @@ proposal. The active operator is unchanged.
474475
`unpause()` clears it. This gives backend operators operational context without
475476
requiring off-chain state tracking.
476477

478+
## Code of Conduct
479+
480+
This project adheres to a code of conduct that all contributors are expected to follow. Please read [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) before contributing.
481+
477482
## Security Considerations
478483

484+
Please refer to our [Security Policy](SECURITY.md) for information on supported versions, our disclosure policy, and how to report a vulnerability.
485+
479486
### Smart Contract Security
480487

481488
- **Deterministic execution:** All calculations use integer math only — no floating point

SECURITY.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
Use this section to tell people about which versions of your project are currently being supported with security updates.
6+
7+
| Version | Supported |
8+
| ------- | ------------------ |
9+
| v1.0.x | :white_check_mark: |
10+
| < v1.0 | :x: |
11+
12+
## Scope
13+
14+
This security policy applies to all smart contracts and related software within the ApexChainx-Contracts repository.
15+
16+
## Reporting a Vulnerability
17+
18+
We take the security of our smart contracts seriously. If you believe you have found a security vulnerability in our contracts, please report it to us as described below.
19+
20+
**Please do not report security vulnerabilities through public GitHub issues.**
21+
22+
Instead, please email your findings to [security@apexchainx.example.com].
23+
24+
### Secure Reporting Method
25+
26+
You can encrypt your communication using our PGP key:
27+
```
28+
-----BEGIN PGP PUBLIC KEY BLOCK-----
29+
...
30+
-----END PGP PUBLIC KEY BLOCK-----
31+
```
32+
*(Please contact us for the actual PGP key if needed, or use the email provided above securely.)*
33+
34+
### Response Timeline
35+
36+
- We will acknowledge receipt of your vulnerability report within 48 hours.
37+
- We will provide a more detailed response to your report within 7 days, including whether we have reproduced the issue and an estimated timeline for remediation.
38+
- We aim to resolve critical issues within 14 days of confirmation.
39+
40+
## Disclosure Policy
41+
42+
We ask that you do not disclose the vulnerability publicly until we have had a chance to address it. We will notify you when the issue has been patched and is safe to disclose. We appreciate your cooperation in keeping our ecosystem secure.

0 commit comments

Comments
 (0)