Skip to content

Commit 0bf817b

Browse files
Update CODE_OF_CONDUCT.md, add CONTRIBUTING.md, and enhance SECURITY.md
- Updated the contact email in CODE_OF_CONDUCT.md for reporting unacceptable behavior. - Added a comprehensive CONTRIBUTING.md file detailing setup, testing, and contribution guidelines. - Expanded SECURITY.md to include a section on reporting vulnerabilities and best practices for using the SDK securely.
1 parent 1c8f204 commit 0bf817b

4 files changed

Lines changed: 123 additions & 1 deletion

File tree

CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
cmake_minimum_required(VERSION 3.20)
2-
project(ZeroBounce VERSION 1.0.0 LANGUAGES CXX)
2+
project(ZeroBounce VERSION 1.1.1 LANGUAGES CXX)
33

44
set(CMAKE_CXX_STANDARD 20)
55
set(CMAKE_CXX_STANDARD_REQUIRED ON)

CODE_OF_CONDUCT.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and maintainers of the Zero Bounce C++ API Wrapper pledge to make participation in our project and community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, 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:
12+
13+
* Using welcoming and inclusive language
14+
* Being respectful of differing viewpoints and experiences
15+
* Gracefully accepting constructive criticism
16+
* Focusing on what is best for the community
17+
* Showing empathy toward other community members
18+
19+
Examples of unacceptable behavior:
20+
21+
* The use of sexualized language or imagery, and unwelcome sexual attention or advances
22+
* Trolling, insulting or derogatory comments, and personal or political attacks
23+
* Public or private harassment
24+
* Publishing others' private information (e.g. physical or email address) without explicit permission
25+
* Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Our Responsibilities
28+
29+
Project maintainers 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+
Project maintainers 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 project spaces, and also applies when an individual is representing the project or its community in public spaces. Examples of representing the project 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 project team at **integrations@zerobounce.net**. All complaints will be reviewed and investigated promptly and fairly. The project team is obligated to maintain confidentiality with regard to the reporter of an incident.
40+
41+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
42+
43+
## Attribution
44+
45+
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][version].
46+
47+
[homepage]: https://www.contributor-covenant.org
48+
[version]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

CONTRIBUTING.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Contributing to Zero Bounce C++ API Wrapper
2+
3+
Thank you for your interest in contributing. This document explains how to get set up and submit changes.
4+
5+
## Code of Conduct
6+
7+
By participating in this project, you agree to uphold our [Code of Conduct](CODE_OF_CONDUCT.md).
8+
9+
## Getting Started
10+
11+
See the [README](README.md) for prerequisites, setup, and how to run tests.
12+
13+
## How to Contribute
14+
15+
### Reporting Bugs
16+
17+
Open an [issue](https://github.com/zerobounce/zerobounce-cpp-api-wrapper/issues) and include:
18+
19+
* Environment details (compiler, OS)
20+
* Steps to reproduce
21+
* Expected vs actual behavior
22+
* Relevant code or error messages
23+
24+
### Suggesting Changes
25+
26+
* Check existing issues and pull requests first.
27+
* Open an issue to discuss larger changes or API design before coding.
28+
29+
### Submitting Changes
30+
31+
1. **Fork** the repository and create a branch from `main`:
32+
```bash
33+
git checkout -b feature/your-feature-name
34+
```
35+
36+
2. **Make your changes** and add or update tests where relevant.
37+
38+
3. **Run the test suite** (see README) before submitting.
39+
40+
4. **Commit** with a clear message (e.g. `Add X`, `Fix Y`).
41+
42+
5. **Push** your branch and open a **Pull Request** against `main`.
43+
44+
6. In the PR description, briefly explain what changed and why. Link any related issues.
45+
46+
Maintainers will review and may request changes. Once approved, your PR can be merged.
47+
48+
## Questions
49+
50+
* [Zero Bounce API docs](https://www.zerobounce.net/docs/)
51+
* [Project homepage](https://zerobounce.net)
52+
* Contact: **integrations@zerobounce.net**
53+
54+
Thanks for contributing.

SECURITY.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,21 @@
11
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
If you think you've found a security issue, please report it privately instead of opening a public issue.
6+
7+
**Email:** integrations@zerobounce.net (use a subject like `[zerobounce-cpp-api-wrapper] Security`).
8+
9+
We'll look into reports as we can. If the issue is in the Zero Bounce API or service rather than this wrapper, we may forward it to the right team.
10+
11+
## Supported Versions
12+
13+
We focus on the current release line for fixes. Using the latest release is recommended.
14+
15+
## Tips for Using This Wrapper
16+
17+
* Don't commit API keys or `.env` files—use environment variables or a secrets manager.
18+
* Keep dependencies up to date and upgrade when new versions are released.
19+
* The client uses HTTPS by default; avoid overriding to non-HTTPS in production.
20+
21+
Thanks for helping keep things secure.

0 commit comments

Comments
 (0)