Skip to content

Conversation

@rossbar
Copy link
Collaborator

@rossbar rossbar commented Nov 25, 2025

Closes #286

Moves the source text for the contributing guide from site/contributing.md to CONTRIBUTING.md in the top-level directory of the repo (this ensures it will also be picked up by the GitHub machinery as well).

Then, we use the {include} directive to inject the contributing material back into the website at build time.

Finally, removes the duplicated text in the README.

NOTE: There are no content changes in this PR, just a reorganization of the existing material.

NOTE2: The first four commits are a result of copying the files in a way that preserves the git history

Copy link
Member

@bsipocz bsipocz left a comment

Choose a reason for hiding this comment

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

The myst flavour doesn't render for github markdown files.

So the alternative would be to store the file under site/; and then just link to the rendered website from CONTRIBURING.md.

Downside: the repo won't really be self contained (well, it is as the source is stored in there, too); but IMO that's OK.

@rossbar
Copy link
Collaborator Author

rossbar commented Nov 25, 2025

The myst flavour doesn't render for github markdown files.

True, but IMV that's a github problem :). In practice, the document renders okay, more-or-less largely due to the fact that ```{whatever}``` gets interpreted as just plain old ``` 's , which is good enough. Sure the admonition renders as a literal block, but these are minor considerations IMV.

I personally prefer this pattern (even with the imperfect rendering on GH) because it follows the pattern folks are used to for repositories.

Copy link
Member

@bsipocz bsipocz left a comment

Choose a reason for hiding this comment

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

OK, let's try this way. We can always switch to my suggestion if we run into problems with this approach.

@bsipocz bsipocz merged commit cca885c into numpy:main Nov 25, 2025
9 checks passed
@rossbar rossbar deleted the dedup-contributing branch November 25, 2025 23:05
github-actions bot pushed a commit to rossbar/numpy-tutorials that referenced this pull request Nov 25, 2025
github-actions bot pushed a commit to dumpmemory/numpy-tutorials that referenced this pull request Nov 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Deduplicate contributing content from README/contributing.md

2 participants