Skip to content

Commit b43e879

Browse files
fix readme, contributing and code of conduct
1 parent 266f92c commit b43e879

3 files changed

Lines changed: 81 additions & 11 deletions

File tree

README.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ With this SDK you can quickly connect to hundreds of certified APIs and accelera
2121

2222
## Pre-requisites
2323

24-
Before using the OpenApi IT Rust Client, you will need an account at [Openapi](https://console.openapi.com/) and an API key to the sandbox and/or production environment
24+
Before using the Openapi Rust Client, you will need an account at [Openapi](https://console.openapi.com/) and an API key to the sandbox and/or production environment
2525

2626
## Installation
2727

28-
You can add the OpenApi IT Rust Client to your project with the following command:
28+
You can add the Openapi Rust Client to your project with the following command:
2929

3030
```bash
3131
cargo add openapi-sdk
@@ -157,19 +157,14 @@ cargo test
157157

158158
## Contributing
159159

160-
Contributions are always welcome!
160+
Contributions are always welcome! See [docs/contributing.md](docs/contributing.md) for ways to get started. Please adhere to this project's [docs/code-of-conduct.md](docs/code-of-conduct.md).
161161

162-
See `contributing.md` for ways to get started.
163-
164-
Please adhere to this project's `code of conduct`.
162+
## Authors
165163

164+
- [@maiku1008](https://www.github.com/maiku1008)
165+
- [@openapi-it](https://github.com/openapi-it)
166166

167167
## License
168168

169169
[MIT](https://choosealicense.com/licenses/mit/)
170170

171-
172-
## Authors
173-
174-
- [@maiku1008](https://www.github.com/maiku1008)
175-
- [@openapi-it](https://github.com/openapi-it)

docs/code-of-conduct.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project a harassment-free experience for everyone.
6+
7+
## Our Standards
8+
9+
Examples of positive behavior:
10+
11+
- Using welcoming and inclusive language
12+
- Being respectful of differing viewpoints and experiences
13+
- Gracefully accepting constructive criticism
14+
- Focusing on what is best for the community
15+
- Showing empathy toward other community members
16+
17+
Examples of unacceptable behavior:
18+
19+
- Harassment, intimidation, or discrimination
20+
- Public or private insults and derogatory comments
21+
- Publishing others’ private information without consent
22+
- Any other conduct reasonably considered inappropriate
23+
24+
## Enforcement
25+
26+
Instances of unacceptable behavior may be reported by contacting the project team at `<hello@openapi.com>`. All complaints will be reviewed promptly and fairly.
27+
28+
## Attribution
29+
30+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1.

docs/contributing.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Contributing to Openapi SDK
2+
3+
Thanks for considering contributing! 🎉
4+
We welcome all kinds of contributions: bug reports, feature requests, documentation improvements, and code enhancements.
5+
6+
## How to Contribute
7+
8+
1. **Fork the repository** and clone it locally:
9+
```bash
10+
git clone https://github.com/<username>/<repo>.git
11+
```
12+
13+
2. **Create a branch** for your feature or fix:
14+
```bash
15+
git checkout -b feature/your-feature-name
16+
```
17+
18+
3. **Make your changes** and commit them:
19+
```bash
20+
git commit -m "Add some feature"
21+
```
22+
23+
4. **Push your branch** to your fork:
24+
```bash
25+
git push origin feature/your-feature-name
26+
```
27+
28+
5. **Open a Pull Request** describing your changes.
29+
30+
## Guidelines
31+
32+
* Follow the existing **Rust coding style**.
33+
* Include **tests** for new features or bug fixes when applicable.
34+
* Keep **commit messages clear and concise**.
35+
* Update **documentation** as needed for your changes.
36+
37+
## Reporting Issues
38+
39+
To report bugs or request features, please **open an issue** on GitHub including:
40+
41+
* Clear description of the problem or feature.
42+
* Steps to reproduce (if applicable).
43+
* Relevant logs or screenshots.
44+
45+
Thank you for helping improve Openapi SDK! 🚀

0 commit comments

Comments
 (0)