-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
733 changed files
with
55 additions
and
52,090 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1 @@ | ||
/dashboard/ @minikin | ||
|
||
/hermes/ @stevenj @Mr-Leshiy @FelipeRosa @cong-or @saibatizoku @minikin | ||
|
||
.md @stevenj @minikin |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Hermes Discussions | ||
url: https://github.com/input-output-hk/hermes/discussions/ | ||
- name: Catalyst Libs Discussions | ||
url: https://github.com/input-output-hk/catalyst-libs/discussions/ | ||
about: Please ask and answer questions here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,24 @@ | ||
# Contributing to Hermes | ||
# Contributing to Catalyst Libs | ||
|
||
First off, thanks for taking the time to contribute! ❤️ | ||
|
||
* [Contributing to Hermes](#contributing-to-hermes) | ||
* [Code of Conduct](#code-of-conduct) | ||
* [I Have a Question](#i-have-a-question) | ||
* [I Want To Contribute](#i-want-to-contribute) | ||
* [Reporting Bugs](#reporting-bugs) | ||
* [Before Submitting a Bug Report](#before-submitting-a-bug-report) | ||
* [How Do I Submit a Good Bug Report?](#how-do-i-submit-a-good-bug-report) | ||
* [Suggesting Enhancements](#suggesting-enhancements) | ||
* [Before Submitting an Enhancement](#before-submitting-an-enhancement) | ||
* [How Do I Submit a Good Enhancement Suggestion?](#how-do-i-submit-a-good-enhancement-suggestion) | ||
* [Your First Code Contribution](#your-first-code-contribution) | ||
* [Improving The Documentation](#improving-the-documentation) | ||
* [Style guides](#style-guides) | ||
* [Rust](#rust) | ||
* [Dart](#dart) | ||
* [Flutter](#flutter) | ||
* [Commit Messages](#commit-messages) | ||
- [Contributing to Catalyst Libs](#contributing-to-catalyst-libs) | ||
- [Code of Conduct](#code-of-conduct) | ||
- [I Have a Question](#i-have-a-question) | ||
- [I Want To Contribute](#i-want-to-contribute) | ||
- [Reporting Bugs](#reporting-bugs) | ||
- [Before Submitting a Bug Report](#before-submitting-a-bug-report) | ||
- [How Do I Submit a Good Bug Report?](#how-do-i-submit-a-good-bug-report) | ||
- [Suggesting Enhancements](#suggesting-enhancements) | ||
- [Before Submitting an Enhancement](#before-submitting-an-enhancement) | ||
- [How Do I Submit a Good Enhancement Suggestion?](#how-do-i-submit-a-good-enhancement-suggestion) | ||
- [Your First Code Contribution](#your-first-code-contribution) | ||
- [Improving The Documentation](#improving-the-documentation) | ||
- [Style guides](#style-guides) | ||
- [Rust](#rust) | ||
- [Dart](#dart) | ||
- [Flutter](#flutter) | ||
- [Commit Messages](#commit-messages) | ||
|
||
All types of contributions are encouraged and valued. | ||
Please make sure to read the relevant section before making your contribution. | ||
|
@@ -28,26 +28,26 @@ The community looks forward to your contributions. 🎉 | |
## Code of Conduct | ||
|
||
This project and everyone participating in it is governed by the | ||
[Hermes Code of Conduct](https://github.com/input-output-hk/hermes/blob/main/CODE_OF_CONDUCT.md). | ||
[catalyst-libs Code of Conduct](https://github.com/input-output-hk/catalyst-libs/blob/main/CODE_OF_CONDUCT.md). | ||
By participating, you are expected to uphold this code. | ||
Please report unacceptable behavior | ||
to <[email protected]>. | ||
|
||
## I Have a Question | ||
|
||
> If you want to ask a question, we assume that you have read the available | ||
[Documentation](https://input-output-hk.github.io/hermes/). | ||
[Documentation](https://input-output-hk.github.io/catalyst-libs/). | ||
|
||
Before you ask a question, it is best to search for existing | ||
[Issues](https://github.com/input-output-hk/hermes/issues) | ||
[Issues](https://github.com/input-output-hk/catalyst-libs/issues) | ||
that might help you. | ||
In case you have found a suitable issue and still need clarification, you can write your question | ||
[here](https://github.com/input-output-hk/hermes/discussions). | ||
[here](https://github.com/input-output-hk/catalyst-libs/discussions). | ||
It is also advisable to search the internet for answers first. | ||
|
||
If you then still feel the need to ask a question and need clarification, we recommend the following: | ||
|
||
* Open an [Issue](https://github.com/input-output-hk/hermes/issues/new/choose). | ||
* Open an [Issue](https://github.com/input-output-hk/catalyst-libs/issues/new/choose). | ||
* Provide as much context as you can about what you're running into. | ||
* Provide project and platform versions (`rustc --version --verbose`, `flutter doctor -v`, etc), | ||
depending on what seems relevant. | ||
|
@@ -67,11 +67,11 @@ Please complete the following steps in advance to help us fix any potential bug | |
* Make sure that you are using the latest version. | ||
* Determine if your bug is really a bug and not an error on your side. | ||
e.g. using incompatible environment components/versions (Make sure that you have read the | ||
[documentation](https://input-output-hk.github.io/hermes). | ||
[documentation](https://input-output-hk.github.io/catalyst-libs). | ||
If you are looking for support, you might want to check [this section](#i-have-a-question). | ||
* To see if other users have experienced (and potentially already solved) the same issue you are having. | ||
Check if there is not already a bug report existing for your bug or error in the | ||
[bug tracker](https://github.com/input-output-hk/hermes/issues?q=is%3Aopen+is%3Aissue+label%3Abug). | ||
[bug tracker](https://github.com/input-output-hk/catalyst-libs/issues?q=is%3Aopen+is%3Aissue+label%3Abug). | ||
* Also make sure to search the internet (including Stack Overflow) | ||
to see if users outside the GitHub community have discussed the issue. | ||
* Collect information about the bug: | ||
|
@@ -92,7 +92,7 @@ Please complete the following steps in advance to help us fix any potential bug | |
We use GitHub issues to track bugs and errors. | ||
If you run into an issue with the project: | ||
|
||
* Open an [Issue](https://github.com/input-output-hk/hermes/issues/new). | ||
* Open an [Issue](https://github.com/input-output-hk/catalyst-libs/issues/new). | ||
(Since we can't be sure at this point whether it is a bug or not, | ||
we ask you not to talk about a bug yet and not to label the issue.) | ||
* Explain the behavior you would expect and the actual behavior. | ||
|
@@ -115,17 +115,17 @@ Once it's filed: | |
|
||
### Suggesting Enhancements | ||
|
||
This section guides you through submitting an enhancement suggestion for Hermes, | ||
This section guides you through submitting an enhancement suggestion for catalyst-libs, | ||
**including completely new features and minor improvements to existing functionality**. | ||
Following these guidelines will help maintainers and the community to understand your suggestion and | ||
find related suggestions. | ||
|
||
#### Before Submitting an Enhancement | ||
|
||
* Make sure that you are using the latest version. | ||
* Read the [documentation](https://github.com/input-output-hk/hermes) carefully. | ||
* Read the [documentation](https://github.com/input-output-hk/catalyst-libs) carefully. | ||
Find out if the functionality is already covered, maybe by an individual configuration. | ||
* Perform a [search](https://github.com/input-output-hk/hermes/issues) | ||
* Perform a [search](https://github.com/input-output-hk/catalyst-libs/issues) | ||
to see if the enhancement has already been suggested. | ||
If it has, add a comment to the existing issue instead of opening a new one. | ||
* Find out whether your idea fits with the scope and aims of the project. | ||
|
@@ -135,7 +135,7 @@ to see if the enhancement has already been suggested. | |
|
||
#### How Do I Submit a Good Enhancement Suggestion? | ||
|
||
Enhancement suggestions are tracked as [GitHub issues](https://github.com/input-output-hk/hermes/issues). | ||
Enhancement suggestions are tracked as [GitHub issues](https://github.com/input-output-hk/catalyst-libs/issues). | ||
|
||
* Use a **clear and descriptive title** for the issue to identify the suggestion. | ||
* Provide a **step-by-step description of the suggested enhancement** in as many details as possible. | ||
|
@@ -146,13 +146,13 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/input- | |
You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, | ||
and [this tool](https://github.com/colinkeenan/silentcast) or | ||
[this tool](https://github.com/GNOME/byzanz) on Linux. | ||
* **Explain why this enhancement would be useful** to most Hermes users. | ||
* **Explain why this enhancement would be useful** to most catalyst-libs users. | ||
You may also want to point out the other projects that solved it better and which could serve as inspiration. | ||
|
||
### Your First Code Contribution | ||
|
||
Embarking on your first code contribution can be an exhilarating yet intimidating endeavor. | ||
Here at Hermes, we foster a welcoming and supportive environment to ensure | ||
Here at catalyst-libs, we foster a welcoming and supportive environment to ensure | ||
that everyone can contribute to the codebase irrespective of their experience level. | ||
Below is a step-by-step guide to making your first code contribution to our repository: | ||
|
||
|
Oops, something went wrong.