Skip to content

hirosystems/signer-metrics-api

   /     /   ▶ Project name   
  / --- /      Project description (one liner).
 /     /       Eli5 (one liner).

Introduction Features Getting started Documentation Contribute

Introduction

Features

Quick-start

Documentation

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:

  1. Search for existing issues: Before submitting a new issue, please search existing and closed issues to check if a similar problem or feature request has already been reported.
  2. Open a new issue: If it hasn't been addressed, please open a new issue. 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.
  3. 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.

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.

Code of Conduct

Please read the projects's Code of conduct since we expect project participants to adhere to it.

Contributing Guide

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes.

Community

Join our community and stay connected with the latest updates and discussions:

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.
  • Follow this GH action examples for Semantic Versioning.
  • If you are using semantic release, you will also want to limnt your commit messages.