Skip to content

Commit ff955a5

Browse files
authored
update contribution guidelines (#182)
* update contribution guidelines * fix link * update * consistency * Code of conduct
1 parent b85257b commit ff955a5

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

async-openai/README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,9 +106,19 @@ async fn main() -> Result<(), Box<dyn Error>> {
106106

107107
## Contributing
108108

109-
Thank you for your time to contribute and improve the project, I'd be happy to have you!
109+
Thank you for taking the time to contribute and improve the project. I'd be happy to have you!
110110

111-
A good starting point would be existing [open issues](https://github.com/64bit/async-openai/issues).
111+
All forms of contributions, such as new features requests, bug fixes, issues, documentation, testing, comments, [examples](../examples) etc. are welcome.
112+
113+
A good starting point would be to look at existing [open issues](https://github.com/64bit/async-openai/issues).
114+
115+
To maintain quality of the project, a minimum of the following is a must for code contribution:
116+
- **Documented**: Primary source of doc comments is description field from OpenAPI spec.
117+
- **Tested**: Examples are primary means of testing and should continue to work. For new features supporting example is required.
118+
- **Scope**: Keep scope limited to APIs available in official documents such as [API Reference](https://platform.openai.com/docs/api-reference) or [OpenAPI spec](https://github.com/openai/openai-openapi/). Other LLMs or AI Providers offer OpenAI-compatible APIs, yet they may not always have full parity. In such cases, the OpenAI spec takes precedence.
119+
- **Consistency**: Keep code style consistent across all the "APIs" that library exposes; it creates a great developer experience.
120+
121+
This project adheres to [Rust Code of Conduct](https://www.rust-lang.org/policies/code-of-conduct)
112122

113123
## Complimentary Crates
114124
- [openai-func-enums](https://github.com/frankfralick/openai-func-enums) provides procedural macros that make it easier to use this library with OpenAI API's tool calling feature. It also provides derive macros you can add to existing [clap](https://github.com/clap-rs/clap) application subcommands for natural language use of command line tools. It also supports openai's [parallel tool calls](https://platform.openai.com/docs/guides/function-calling/parallel-function-calling) and allows you to choose between running multiple tool calls concurrently or own their own OS threads.

0 commit comments

Comments
 (0)