From 641b5ae70a482959fafaacec72c32c0f1afba0c9 Mon Sep 17 00:00:00 2001 From: Scott McClellan Date: Wed, 12 Jul 2023 19:12:12 -0500 Subject: [PATCH] chore: improve README.md standardization --- .github/ISSUE_TEMPLATE/config.yml | 4 ++++ README.md | 23 +++++++++++++++++++++++ 2 files changed, 27 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..9e27ed982 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,4 @@ +contact_links: + - name: Ask the community + url: https://discord.gg/KrqnVg8D + about: Ask and discuss questions with other Stacks community developers. \ No newline at end of file diff --git a/README.md b/README.md index b3b1b9683..93b23bb18 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,16 @@ Documentation and library references for the stacks.js packages are located at [ To migrate your app from blockstack.js to Stacks.js follow the steps in the respective [migration guide](./.github/MIGRATION.md). +## Bugs and feature requests + +If you encounter a bug or have a feature request, we encourage you to follow the steps below: + + 1. **Search for existing issues:** Before submitting a new issue, please search [existing and closed issues](../../issues) to check if a similar problem or feature request has already been reported. + 1. **Open a new issue:** If it hasn't been addressed, please [open a new issue](../../issues/new/choose). Choose the appropriate issue template and provide as much detail as possible, including steps to reproduce the bug or a clear description of the requested feature. + 1. **Evaluation SLA:** Our team reads and evaluates all the issues and pull requests. We are avaliable Monday to Friday and we make a best effort to respond within 7 business days. + +Please **do not** use the issue tracker for personal support requests or to ask for the status of a transaction. You'll find help at the [#support Discord channel](https://discord.gg/SK3DxdsP). + ## Contributing & Development Github issues marked [help-wanted](https://github.com/hirosystems/stacks.js/labels/help-wanted) @@ -62,3 +72,16 @@ To setup the development environment for this repository, follow these steps: > Some tests may contain logging of errors and warnings. > This should not be confused with failing tests. > Make sure the last lines of `npm run test` show `lerna success - @stacks/...` for every package. + +### Code of Conduct +Please read our [Code of conduct](../../../.github/blob/main/CODE_OF_CONDUCT.md) since we expect project participants to adhere to it. + +## Community + +Join our community and stay connected with the latest updates and discussions: + +- [Join our Discord community chat](https://discord.gg/ZQR6cyZC) to engage with other users, ask questions, and participate in discussions. + +- [Visit hiro.so](https://www.hiro.so/) for updates and subcribing to the mailing list. + +- Follow [Hiro on Twitter.](https://twitter.com/hirosystems)