Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update template to be more broadly useful #2

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: update template to be more broadly useful #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 8 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,25 +23,20 @@

## Bugs and feature requests

If you encounter a bug or have a feature request for the Stacks Explorer, we encourage you to follow the steps below:
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](https://github.com/hirosystems/.github/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](https://github.com/hirosystems/.github/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. **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. You'll find help at the [#support Discord channel](https://discord.gg/SK3DxdsP).
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).

## Contribute

## Contributing

Development of this project happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving this project.
Development of this product happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving the product.

### Code of Conduct
Please read the projects's [Code of conduct](https://github.com/hirosystems/.github/blob/main/CODE_OF_CONDUCT.md) since we expect project participants to adhere to it.

### Contributing Guide
Read our [contributing guide](https://github.com/hirosystems/.github/blob/main/.github/CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes.

Please read our [Code of conduct](../../../.github/blob/main/CODE_OF_CONDUCT.md) since we expect project participants to adhere to it.

## Community

Expand All @@ -53,14 +48,10 @@ Join our community and stay connected with the latest updates and discussions:

- Follow [Hiro on Twitter.](https://twitter.com/hirosystems)

## License

This project is open source and released under the Apache 2 License.

# Notes to use this template

- Start from this template for public repository.
- You'll need to fine tune this readme, as well as the contributions guides, and issue and PR templates.
- If you need a project board, you'll find the Hiro board template on the options while [creating a new board](https://github.com/orgs/hirosystems/projects).
- Follow this [GH action examples for Semantic Versioning](https://github.com/hirosystems/gh-actions-example).
- If you are using semantic release, you will also want to limnt your commit messages.
- If you are using semantic release, you will also want to lint your commit messages.