Skip to content

Commit 64a9ce5

Browse files
chore: improve contribution guidelines
1 parent e393da1 commit 64a9ce5

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -201,15 +201,19 @@ This repository is maintained by Speakeasy, but we welcome and encourage contrib
201201

202202
### How to Contribute
203203

204-
1. **Open Issues**: Found a bug or have a feature suggestion? Open an issue to describe what you'd like to see changed.
204+
1. **Discussions**: Have a feature request or want to discuss the roadmap? Use [GitHub Discussions](https://github.com/speakeasy-api/openapi/discussions) to share your ideas and engage with the community.
205205

206-
2. **Pull Requests**: We welcome pull requests! If you'd like to contribute code:
206+
2. **Issues**: Found a bug or technical issue? Open a [GitHub Issue](https://github.com/speakeasy-api/openapi/issues) to report it with details about the problem.
207+
208+
3. **Pull Requests**: We welcome pull requests! If you'd like to contribute code:
207209
- Fork the repository
208210
- Create a new branch for your feature/fix
209211
- Submit a PR with a clear description of the changes and any related issues
210212

211-
3. **Feedback**: Share your experience using the packages or suggest improvements.
213+
4. **Feedback**: Share your experience using the packages or suggest improvements.
214+
215+
**Getting Started**: Look for items tagged with "good first issue" in both [Discussions](https://github.com/speakeasy-api/openapi/discussions) and [Issues](https://github.com/speakeasy-api/openapi/issues) if you want to pick up something to work on.
212216

213-
All contributions, whether they're bug reports, feature requests, or code changes, help make this project better for everyone.
217+
All contributions, whether they're feature requests, bug reports, or code changes, help make this project better for everyone.
214218

215219
Please ensure your contributions adhere to our coding standards and include appropriate tests where applicable.

cmd/openapi/commands/arazzo/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Commands for working with Arazzo workflow documents.
44

5-
Arazzo workflows describe sequences of API calls and their dependencies. These commands help you validate and work with Arazzo documents according to the [Arazzo Specification](https://spec.openapis.org/arazzo/v1.0.0).
5+
Arazzo workflows describe sequences of API calls and their dependencies. These commands help you validate and work with Arazzo documents according to the [Arazzo Specification](https://spec.openapis.org/arazzo/v1.0.1).
66

77
## Table of Contents
88

0 commit comments

Comments
 (0)