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

Add docs folder #720

Merged
merged 3 commits into from
Oct 13, 2024
Merged

Add docs folder #720

merged 3 commits into from
Oct 13, 2024

Conversation

niccokunzmann
Copy link
Member

@niccokunzmann niccokunzmann commented Oct 10, 2024

fixes #712

To Reproduce -> These commands work now. The docs are added.


📚 Documentation preview 📚: https://icalendar--720.org.readthedocs.build/

@niccokunzmann
Copy link
Member Author

@mgorny, I had a look and it turns out the fix is simple.

@coveralls
Copy link

coveralls commented Oct 10, 2024

Pull Request Test Coverage Report for Build 11306099255

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-0.07%) to 97.315%

Totals Coverage Status
Change from base Build 11199956195: -0.07%
Covered Lines: 3190
Relevant Lines: 3273

💛 - Coveralls

@mgorny
Copy link
Contributor

mgorny commented Oct 10, 2024

Thanks!

@niccokunzmann
Copy link
Member Author

niccokunzmann commented Oct 11, 2024

@stevepiercy would you like to have a review look? You like the docs, too :)

Copy link
Member

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

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

I like grammatically correct sentences using the past verb tense in change log notes, because after publication it will be in the past.

Also I like error messages to tell me both what the problem is and what explicit action I need to do next to resolve it.

Thanks for asking for my review.

CHANGES.rst Outdated Show resolved Hide resolved
src/icalendar/tests/test_create_release.sh Outdated Show resolved Hide resolved
niccokunzmann and others added 2 commits October 12, 2024 14:36
Co-authored-by: Steve Piercy <web@stevepiercy.com>
Co-authored-by: Steve Piercy <web@stevepiercy.com>
@niccokunzmann
Copy link
Member Author

niccokunzmann commented Oct 12, 2024

@stevepiercy thanks for the review! I agree with the error messages being more of a guide.

When it comes to the changelog. My reasoning behind present tense is this:

In some practice, commits are formulated in this way:
Apply this commit to [commit message]
.... Log changes
.... Add feature
.... Remove error
There, it is a bit imperative present tense. So, the changelog can be close to that but I really do not mind how people write their changelog as long as it is descriptive enough - very vague.

I value the contribution, contributions from a diverse background are divers. Asking to conform and make lots of changes might not be as inclusive when it comes to time invested voluntarily - that is my reasoning when it comes to external and first-time contributions.

In the team, we can agree on disciplines for us:)

Feel free to merge as I would not add anything... I just have to wait for 1 week to merge my own PR.

Copy link
Member

@stevepiercy stevepiercy 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 for the explanation of change log policy.

@niccokunzmann niccokunzmann merged commit f2c017d into collective:main Oct 13, 2024
17 checks 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.

[BUG] 6.0.0 sdist lost docs folder, causing tests to fail
4 participants