1
1
# Contributing to Hydra
2
2
3
- Thanks for considering contributing and help us on creating the Hydra protocols!
3
+ Thanks for considering contributing and help us on creating the Hydra protocols!
4
4
5
5
The best way to contribute right now is to try things out and provide feedback,
6
6
but we also accept contributions to the documentation and the obviously to the
@@ -13,7 +13,7 @@ your contribution gets accepted, making you our newest Hydra contributor!
13
13
14
14
See [ ` SUPPORT.md ` ] ( SUPPORT.md ) should you have any questions or need some help in getting set up.
15
15
16
- ## Your first contribution
16
+ ## Your first contribution
17
17
18
18
Contributing to the documentation, its translation, reporting bugs or proposing features are awesome ways to get started.
19
19
@@ -126,12 +126,26 @@ propose new standards or changes to the existing standards, file an issue.
126
126
127
127
### Creating a pull request
128
128
129
- Thank you for contributing your changes by opening a pull requests! To get
130
- something merged we usually require:
129
+ Thank you for contributing your changes by opening a pull requests!
130
+
131
+ On top of the aforementioned _ Coding standards_ , to get something merged would usually require:
131
132
+ Description of the changes - if your commit messages are great, this is less important
132
133
+ Quality of changes is ensured - through new or updated automated tests
133
134
+ Change is related to an issue, feature (idea) or bug report - ideally discussed beforehand
134
135
+ Well-scoped - we prefer multiple PRs, rather than a big one
136
+ + Correctness - a PR should pass all the build and test steps in the CI
137
+
138
+ Merging a PR requires approval from a majority of reviewers from the
139
+ core _ Hydra engineering_ team. This implies that:
140
+ + Contributions from outside this core team would need 3 approvals,
141
+ + Contributions from a single core team member would need 2 approvals,
142
+ + PRs developed in pair would need a single approval,
143
+ + and of course PRs developed in ensembles would not need any approval.
144
+
145
+ The reason behind this policy is to increase the [ bus
146
+ factor] ( https://en.wikipedia.org/wiki/Bus_factor ) on the project,
147
+ disseminating information about contributions and changes in order to
148
+ prevent creation of a bottleneck.
135
149
136
150
### Updating dependencies
137
151
@@ -227,7 +241,7 @@ To write such an update:
227
241
3 . Create a entry blog and pull request it on
228
242
[ cardano-updates] ( https://github.com/input-output-hk/cardano-updates ) ,
229
243
putting other Hydra contributors as reviewers.
230
-
244
+
231
245
- Don't forget to add yourself as author in the ` authors.yml ` .
232
246
233
247
### Monthly review & report
0 commit comments