Skip to content

Add CONTRIBUTING.md, update and expand README.md#90

Merged
moranegg merged 4 commits intocodemeta:masterfrom
meldra:contrib-2025
Dec 4, 2025
Merged

Add CONTRIBUTING.md, update and expand README.md#90
moranegg merged 4 commits intocodemeta:masterfrom
meldra:contrib-2025

Conversation

@meldra
Copy link
Copy Markdown
Contributor

@meldra meldra commented Nov 25, 2025

This addresses one part of #55. Please critique any assumptions I've made. I have likely also missed stuff.

Comment thread CONTRIBUTING.md Outdated
Comment on lines +56 to +58
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.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you mention here that they should run Hugo to test their changes?

(or just point to the README)

Comment thread CONTRIBUTING.md
Please refer to the
[instructions for contributing](https://github.com/codemeta/codemeta/?tab=contributing-ov-file)
to that repository.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@moranegg
Copy link
Copy Markdown
Member

Global comment : this guide is super clear and detailed.
Thanks @meldra for all the efforts.
It really shows all the improvements in this updated website.

@moranegg
Copy link
Copy Markdown
Member

moranegg commented Nov 26, 2025 via email

@meldra
Copy link
Copy Markdown
Contributor Author

meldra commented Nov 26, 2025

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.

@moranegg moranegg merged commit 3cb9de8 into codemeta:master Dec 4, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants