1
- # Contributing to Hermes
1
+ # Contributing to Catalyst Libs
2
2
3
3
First off, thanks for taking the time to contribute! ❤️
4
4
5
- * [ Contributing to Hermes ] ( #contributing-to-hermes )
6
- * [ Code of Conduct] ( #code-of-conduct )
7
- * [ I Have a Question] ( #i-have-a-question )
8
- * [ I Want To Contribute] ( #i-want-to-contribute )
9
- * [ Reporting Bugs] ( #reporting-bugs )
10
- * [ Before Submitting a Bug Report] ( #before-submitting-a-bug-report )
11
- * [ How Do I Submit a Good Bug Report?] ( #how-do-i-submit-a-good-bug-report )
12
- * [ Suggesting Enhancements] ( #suggesting-enhancements )
13
- * [ Before Submitting an Enhancement] ( #before-submitting-an-enhancement )
14
- * [ How Do I Submit a Good Enhancement Suggestion?] ( #how-do-i-submit-a-good-enhancement-suggestion )
15
- * [ Your First Code Contribution] ( #your-first-code-contribution )
16
- * [ Improving The Documentation] ( #improving-the-documentation )
17
- * [ Style guides] ( #style-guides )
18
- * [ Rust] ( #rust )
19
- * [ Dart] ( #dart )
20
- * [ Flutter] ( #flutter )
21
- * [ Commit Messages] ( #commit-messages )
5
+ - [ Contributing to Catalyst Libs ] ( #contributing-to-catalyst-libs )
6
+ - [ Code of Conduct] ( #code-of-conduct )
7
+ - [ I Have a Question] ( #i-have-a-question )
8
+ - [ I Want To Contribute] ( #i-want-to-contribute )
9
+ - [ Reporting Bugs] ( #reporting-bugs )
10
+ - [ Before Submitting a Bug Report] ( #before-submitting-a-bug-report )
11
+ - [ How Do I Submit a Good Bug Report?] ( #how-do-i-submit-a-good-bug-report )
12
+ - [ Suggesting Enhancements] ( #suggesting-enhancements )
13
+ - [ Before Submitting an Enhancement] ( #before-submitting-an-enhancement )
14
+ - [ How Do I Submit a Good Enhancement Suggestion?] ( #how-do-i-submit-a-good-enhancement-suggestion )
15
+ - [ Your First Code Contribution] ( #your-first-code-contribution )
16
+ - [ Improving The Documentation] ( #improving-the-documentation )
17
+ - [ Style guides] ( #style-guides )
18
+ - [ Rust] ( #rust )
19
+ - [ Dart] ( #dart )
20
+ - [ Flutter] ( #flutter )
21
+ - [ Commit Messages] ( #commit-messages )
22
22
23
23
All types of contributions are encouraged and valued.
24
24
Please make sure to read the relevant section before making your contribution.
@@ -28,26 +28,26 @@ The community looks forward to your contributions. 🎉
28
28
## Code of Conduct
29
29
30
30
This project and everyone participating in it is governed by the
31
- [ Hermes Code of Conduct] ( https://github.com/input-output-hk/hermes /blob/main/CODE_OF_CONDUCT.md ) .
31
+ [ catalyst-libs Code of Conduct] ( https://github.com/input-output-hk/catalyst-libs /blob/main/CODE_OF_CONDUCT.md ) .
32
32
By participating, you are expected to uphold this code.
33
33
Please report unacceptable behavior
34
34
35
35
36
36
## I Have a Question
37
37
38
38
> If you want to ask a question, we assume that you have read the available
39
- [ Documentation] ( https://input-output-hk.github.io/hermes / ) .
39
+ [ Documentation] ( https://input-output-hk.github.io/catalyst-libs / ) .
40
40
41
41
Before you ask a question, it is best to search for existing
42
- [ Issues] ( https://github.com/input-output-hk/hermes /issues )
42
+ [ Issues] ( https://github.com/input-output-hk/catalyst-libs /issues )
43
43
that might help you.
44
44
In case you have found a suitable issue and still need clarification, you can write your question
45
- [ here] ( https://github.com/input-output-hk/hermes /discussions ) .
45
+ [ here] ( https://github.com/input-output-hk/catalyst-libs /discussions ) .
46
46
It is also advisable to search the internet for answers first.
47
47
48
48
If you then still feel the need to ask a question and need clarification, we recommend the following:
49
49
50
- * Open an [ Issue] ( https://github.com/input-output-hk/hermes /issues/new/choose ) .
50
+ * Open an [ Issue] ( https://github.com/input-output-hk/catalyst-libs /issues/new/choose ) .
51
51
* Provide as much context as you can about what you're running into.
52
52
* Provide project and platform versions (` rustc --version --verbose ` , ` flutter doctor -v ` , etc),
53
53
depending on what seems relevant.
@@ -67,11 +67,11 @@ Please complete the following steps in advance to help us fix any potential bug
67
67
* Make sure that you are using the latest version.
68
68
* Determine if your bug is really a bug and not an error on your side.
69
69
e.g. using incompatible environment components/versions (Make sure that you have read the
70
- [ documentation] ( https://input-output-hk.github.io/hermes ) .
70
+ [ documentation] ( https://input-output-hk.github.io/catalyst-libs ) .
71
71
If you are looking for support, you might want to check [ this section] ( #i-have-a-question ) .
72
72
* To see if other users have experienced (and potentially already solved) the same issue you are having.
73
73
Check if there is not already a bug report existing for your bug or error in the
74
- [ bug tracker] ( https://github.com/input-output-hk/hermes /issues?q=is%3Aopen+is%3Aissue+label%3Abug ) .
74
+ [ bug tracker] ( https://github.com/input-output-hk/catalyst-libs /issues?q=is%3Aopen+is%3Aissue+label%3Abug ) .
75
75
* Also make sure to search the internet (including Stack Overflow)
76
76
to see if users outside the GitHub community have discussed the issue.
77
77
* Collect information about the bug:
@@ -92,7 +92,7 @@ Please complete the following steps in advance to help us fix any potential bug
92
92
We use GitHub issues to track bugs and errors.
93
93
If you run into an issue with the project:
94
94
95
- * Open an [ Issue] ( https://github.com/input-output-hk/hermes /issues/new ) .
95
+ * Open an [ Issue] ( https://github.com/input-output-hk/catalyst-libs /issues/new ) .
96
96
(Since we can't be sure at this point whether it is a bug or not,
97
97
we ask you not to talk about a bug yet and not to label the issue.)
98
98
* Explain the behavior you would expect and the actual behavior.
@@ -115,17 +115,17 @@ Once it's filed:
115
115
116
116
### Suggesting Enhancements
117
117
118
- This section guides you through submitting an enhancement suggestion for Hermes ,
118
+ This section guides you through submitting an enhancement suggestion for catalyst-libs ,
119
119
** including completely new features and minor improvements to existing functionality** .
120
120
Following these guidelines will help maintainers and the community to understand your suggestion and
121
121
find related suggestions.
122
122
123
123
#### Before Submitting an Enhancement
124
124
125
125
* Make sure that you are using the latest version.
126
- * Read the [ documentation] ( https://github.com/input-output-hk/hermes ) carefully.
126
+ * Read the [ documentation] ( https://github.com/input-output-hk/catalyst-libs ) carefully.
127
127
Find out if the functionality is already covered, maybe by an individual configuration.
128
- * Perform a [ search] ( https://github.com/input-output-hk/hermes /issues )
128
+ * Perform a [ search] ( https://github.com/input-output-hk/catalyst-libs /issues )
129
129
to see if the enhancement has already been suggested.
130
130
If it has, add a comment to the existing issue instead of opening a new one.
131
131
* 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.
135
135
136
136
#### How Do I Submit a Good Enhancement Suggestion?
137
137
138
- Enhancement suggestions are tracked as [ GitHub issues] ( https://github.com/input-output-hk/hermes /issues ) .
138
+ Enhancement suggestions are tracked as [ GitHub issues] ( https://github.com/input-output-hk/catalyst-libs /issues ) .
139
139
140
140
* Use a ** clear and descriptive title** for the issue to identify the suggestion.
141
141
* 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-
146
146
You can use [ this tool] ( https://www.cockos.com/licecap/ ) to record GIFs on macOS and Windows,
147
147
and [ this tool] ( https://github.com/colinkeenan/silentcast ) or
148
148
[ this tool] ( https://github.com/GNOME/byzanz ) on Linux.
149
- * ** Explain why this enhancement would be useful** to most Hermes users.
149
+ * ** Explain why this enhancement would be useful** to most catalyst-libs users.
150
150
You may also want to point out the other projects that solved it better and which could serve as inspiration.
151
151
152
152
### Your First Code Contribution
153
153
154
154
Embarking on your first code contribution can be an exhilarating yet intimidating endeavor.
155
- Here at Hermes , we foster a welcoming and supportive environment to ensure
155
+ Here at catalyst-libs , we foster a welcoming and supportive environment to ensure
156
156
that everyone can contribute to the codebase irrespective of their experience level.
157
157
Below is a step-by-step guide to making your first code contribution to our repository:
158
158
0 commit comments