Add CONTRIBUTING.md, update and expand README.md #90
Conversation
CONTRIBUTING.md
Outdated
| Make your changes as discussed and commit them to your local copy. Include the | ||
| issue number somewhere in a commit message, prefixed with a `#`, eg, `#999`. | ||
| This will prompt GitHub to create a link back to the issue. |
There was a problem hiding this comment.
Could you mention here that they should run Hugo to test their changes?
(or just point to the README)
| Please refer to the | ||
| [instructions for contributing](https://github.com/codemeta/codemeta/?tab=contributing-ov-file) | ||
| to that repository. | ||
|
|
There was a problem hiding this comment.
Here could be nice to add a section on the display of crosswalks here, which requires the creation of an empty file to make the link between the crosswalk in the codemeta/codemeta repo and this one.
This section can also contain the information on logo location.
There was a problem hiding this comment.
Thank you! I did look at how it works but didn't notice that the file creation here was not automated.
And yes this should probably also mention adding the logos for those.
|
Global comment : this guide is super clear and detailed. |
|
If I remember correctly, a static file needs to be created with the a
description:
https://github.com/codemeta/codemeta.github.io/blob/master/content%2Fcrosswalk%2Fcargo.md
Then the automatic part is fetching the .csv from codemeta/codemeta + the
inclusion in the crosswalks index.
|
|
Pushed up a revision with that section. Let me know if I've missed or misinterpreted anything. I think I've correctly captured the specifics required re: naming and the shortcode? As an aside, there are a bunch of crosswalks in main without these files website side. |
3 participants
This addresses one part of #55. Please critique any assumptions I've made. I have likely also missed stuff.