From c85655fe268800b6551b3355f2bf7e0cb5ec5efa Mon Sep 17 00:00:00 2001 From: Ashley Williams Date: Mon, 19 Dec 2022 13:59:00 -0600 Subject: [PATCH] feat: add CONTRIBUTING.md --- CONTRIBUTING.md | 33 +++++++++++++++++++++++++++++++++ README.md | 8 -------- 2 files changed, 33 insertions(+), 8 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5321b7f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +# Contributing + +Thanks so much for your interest in contributing to `axohtml`. We are excited +about the building a community of contributors to the project. Here's some +guiding principles for working with us: + +**1. File an issue first!** + +Except for the absolute tiniest of PRs (e.g. a single typo fix), please file an +issue before opening a PR. This can help ensure that the problem you are trying +to solve and the solution you have in mind will be accepted. Where possible, we +don't want folks wasting time on directions we don't want to take the project. + +**2. Write tests, or at least detailed reproduction steps** + +If you find a bug, the best way to prioritize getting it fixed is to open a PR +with a failing test! If you a opening a bug fix PR, please add a test to show +that your fix works. + +**3. Overcommunicate** + +In all scenarios, please provide as much context as possible- you may not think +it's important but it may be! + +**4. Patience** + +Axo is a very small company, it's possible that we may not be able to +immediately prioritize your issue. We are excite to develop a community of +contributors around this project, but it won't always be on the top of our to-do +list, even if we wish it could be. + +If you haven't heard from us in a while and want to check in, feel free to +at-mention @ashleygwilliams- but please be kind while doing so! diff --git a/README.md b/README.md index 06498a7..e11d940 100644 --- a/README.md +++ b/README.md @@ -14,14 +14,6 @@ maintain the Wasm compatibility (for now). [Bodil Stokke's]: https://github.com/bodil [typed-html]: https://github.com/bodil/typed-html -## Company-focused Maintenance - -This project is currently being maintained soley for use in [@axodotdev's] -open source projects. Feel free to file issues or PRs but anticipate that they -won't be prioritized (for now). - -[@axodotdev's]: https://github.com/axodotdev - ## Quick Preview ```rust