Adding contributing guidelines #192
Conversation
|
Untested LGTM. One suggestion would be to add |
|
@harding thanks for pointing that out. added |
There was a problem hiding this comment.
Looks great. Just one nit inline to add to Jonas's.
I was imagining that we'd add wording to the live compatibility page at https://bitcoinops.org/en/compatibility/ instructing people on how to contribute. I think that should just be a link to https://github.com/bitcoinops/bitcoinops.github.io/blob/master/CONTRIBUTING.md.
|
Pushed commits with changes based on @adamjonas and @jnewbery feedback (cheers). |
en/compatibility.md
Outdated
| @@ -11,6 +11,11 @@ th, td { text-align: center; } | |||
| h1, h2, h3, h4, h5, h6 { text-align: center; } | |||
| </style> | |||
|
|
|||
| The compatibility dashboard displays evaluation of different Bitcoin wallets | |||
| adoption of scaling technologies. If you are interested in contributing, please review the | |||
| [contibuting guidelines](https://github.com/bitcoinops/bitcoinops.github.io/blob/master/CONTRIBUTING.md). | |||
There was a problem hiding this comment.
s/[contibuting/[contributing/
en/compatibility.md
Outdated
| @@ -11,6 +11,11 @@ th, td { text-align: center; } | |||
| h1, h2, h3, h4, h5, h6 { text-align: center; } | |||
| </style> | |||
|
|
|||
| The compatibility dashboard displays evaluation of different Bitcoin wallets | |||
There was a problem hiding this comment.
-
it looks like "evaluation" here should be "evaluations" or "an evaluation"
-
perhaps s/different/various/
-
s/wallets/wallets'/
README.md
Outdated
|
|
||
| ## Contributing | ||
|
|
||
| If you would like to contribute to the Bitcoin Optech project, review the |
There was a problem hiding this comment.
s/review/please review/?
CONTRIBUTING.md
Outdated
| wallet/service. These files are free for anyone to repurpose/republish | ||
| elsewhere. | ||
|
|
||
| We welcome pull requests to the compatibility section of the site including |
CONTRIBUTING.md
Outdated
|
|
||
| We welcome pull requests to the compatibility section of the site including | ||
| testing the latest versions of previously tested services/wallets, adding notable | ||
| usability screenshots, or adding of new service/wallet tests. |
There was a problem hiding this comment.
perhaps s/adding of new/adding new/, like "adding notable" just before, and "wallet or service tests".
CONTRIBUTING.md
Outdated
| The compatibility section of the website is built from | ||
| [YAML](https://yaml.org/) files located in [_data/compatibility/](_data/compatibility/). | ||
| The compatibility images (usability screenshots, logos) are located in | ||
| [img/compatibility/](img/compatibility/) with sub folders for each |
There was a problem hiding this comment.
s/sub folders/sub-folders/
CONTRIBUTING.md
Outdated
| [YAML](https://yaml.org/) files located in [_data/compatibility/](_data/compatibility/). | ||
| The compatibility images (usability screenshots, logos) are located in | ||
| [img/compatibility/](img/compatibility/) with sub folders for each | ||
| wallet/service. These files are free for anyone to repurpose/republish |
There was a problem hiding this comment.
perhaps "wallet or service."
CONTRIBUTING.md
Outdated
| If you believe any of the data in the compatibility section is incorrect, you | ||
| can also [submit an issue](../../issues/) detailing what is wrong and how to correct it. | ||
|
|
||
| If you want to request a new service/wallet be evaluated, or a new test that you |
There was a problem hiding this comment.
perhaps "wallet or service"
| @@ -18,7 +18,7 @@ founding sponsors and contributions from member companies. | |||
| If you're an engineer or manager at a Bitcoin company or an open source contributor and you'd like to be a part of this, please | |||
| contact us at [[email protected]](mailto:[email protected]). | |||
|
|
|||
| #### Building The Site Locally | |||
| ## Building The Site Locally | |||
|
Added a commit moving the contributing note to the bottom of the compatibility overview page. Let me know what you think @bitschmidty |
Yes, I prefer that as well. |
bitschmidty
force-pushed
the
compatibility-readme-contributions
branch
from
ba52026 to
01dfb2a
Compare
This PR adds contributing guidelines for the compatibility matrix as well as the newsletters.