Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update contrib guide #206

Merged
merged 5 commits into from
Aug 22, 2024
Merged

Update contrib guide #206

merged 5 commits into from
Aug 22, 2024

Conversation

shoeffner
Copy link
Collaborator

@shoeffner shoeffner commented Jul 22, 2024

(Note that this PR already refers to changes which are included in #205 ).

I updated the contrib guide as follows:

Replace duplicate refs with anonymous refs

For example:

`Abc <https://example.org/abc.html>`_
`Abc <https://abc.example.org/>`_

Would cause the rst parser to complain about duplicate refs.
Replacing _ with __ makes the ref anonymous, i.e., Abc will
no longer be treated as the ref name.

`Abc <https://example.org/abc.html>`__
`Abc <https://abc.example.org/>`__

Include CONTRIBUTING.rst properly

While building the docs with tox -e docs, ../CONTRIBUTING.rst was missing.
After fixing this, there was no link to the Contributor Guide due to a
missing title. So I added the title to contributing/contributing.rst and
included CONTRIBUTING.rst from line 3 to prevent the double title.
Finally, the language had to be set to non-None to avoid another WARNING.

Update the contrib guide

  • I updated refs to develop/master to use main.
  • I changed the setup guide to refer to poetry and tox, and explained a little bit more how to run the tests / setup the test environment (including .env and handling environment variables for poetry/tox)
  • I updated how to build the docs with tox via poetry and how to serve them with a local browser
  • I added a few notes on the docker compose setup and some hints on possible pitfalls I encountered when attempting to debug the tests.

Closes #193 .

For example:

`Abc <https://example.org/abc.html>`_
`Abc <https://abc.example.org/>`_

Would cause the rst parser to complain about duplicate refs.
Replacing _ with __ makes the ref anonymous, i.e., Abc will
no longer be treated as the ref name.

Relates to gdcc#193.
While building the docs with tox -e docs, ../CONTRIBUTING.rst was missing.
After fixing this, there was no link to the Contributor Guide due to a
missing title. So I added the title to contributing/contributing.rst and
included CONTRIBUTING.rst from line 3 to prevent the double title.
Finally, the language had to be set to non-None to avoid another WARNING.
@shoeffner shoeffner marked this pull request as ready for review July 24, 2024 23:38
Copy link
Member

@JR-1991 JR-1991 left a comment

Choose a reason for hiding this comment

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

LGTM - Thanks!

@JR-1991 JR-1991 added this to the 0.3.4 milestone Aug 21, 2024
@JR-1991 JR-1991 merged commit 44ec54e into gdcc:main Aug 22, 2024
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
Development

Successfully merging this pull request may close these issues.

Update the Contributor Guide
2 participants