diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md deleted file mode 100644 index 98e7fd1..0000000 --- a/.github/CONTRIBUTING.md +++ /dev/null @@ -1,4 +0,0 @@ -# Contributing - -See our [contributing guidelines](https://icalendar.readthedocs.io/en/latest/contributing.html) -for complete information on how to contribute to icalendar. \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 6595c59..7137915 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,17 +1,15 @@ - +## Closes issue +Replace `ISSUE_NUMBER` with the issue number that your pull request fixes. Then GitHub will link and automatically close the related issue. +- [ ] Closes #ISSUE_NUMBER -**Fixes #** +## Description +Write a description of the fixes or improvements. -**Description:** - +## Checklist +- [ ] Added or updated tests if applicable. +- [ ] All tests pass locally. See https://icalendar.readthedocs.io/en/latest/install.html#running-tests. +- [ ] Added entry to `CHANGES.rst`. +- [ ] Added myself to `docs/credits.rst`. -**Checklist:** -- [ ] Added entry to `CHANGES.rst` -- [ ] Added/updated tests (if applicable) -- [ ] Added myself to `docs/credits.rst` -- [ ] All tests pass - -**Additional Information:** - \ No newline at end of file +## Additional information +Upload screenshots, videos, links to documentation, or any other relevant information. \ No newline at end of file diff --git a/CHANGES.rst b/CHANGES.rst index ebd4ade..5dd1905 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -25,7 +25,7 @@ Minor changes: - Add improved setters for ``start``, ``duration``, and ``end`` properties with explicit locking mechanisms to provide more flexible property manipulation while maintaining RFC 5545 compliance. The implementation includes comprehensive test coverage to ensure proper behavior and backward compatibility. - Add ``new()`` method to ``vCalAddress`` class for consistent API usage. The method supports all RFC 5545 parameters including ``CN``, ``CUTYPE``, ``DELEGATED-FROM``, ``DELEGATED-TO``, ``DIR``, ``LANGUAGE``, ``PARTSTAT``, ``ROLE``, ``RSVP``, and ``SENT-BY``, with automatic ``mailto:`` prefix handling. See `Issue 870 `_. - Refactor ``set_duration`` methods in ``Event`` and ``Todo`` classes to eliminate code duplication by extracting common logic into shared ``set_duration_with_locking()`` function in ``icalendar.attr``. See `Issue 886 `_. -- Make ``CHANGES.rst`` requirement more prominent in contributing documentation by adding PR template, updating README.rst, and enhancing CONTRIBUTING.rst with clear CI enforcement warnings. See `Issue 890 `_. +- Make ``CHANGES.rst`` requirement more prominent in contributing documentation by adding a pull request template, updating ``README.rst``, and enhancing ``CONTRIBUTING.rst`` with clear CI enforcement warnings. See `Issue 890 `_. - Make coverage submission optional for CI Breaking changes: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..793502b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,42 @@ +# Contributing + +See our [contributing guidelines](https://icalendar.readthedocs.io/en/latest/contributing.html) for complete information on how to contribute to icalendar. + +## Contribution examples + +- Reporting issues to the bugtracker. +- Submitting pull requests from a forked icalendar repo. +- Extending the documentation. +- Sponsor a Sprint (https://plone.org/events/sprints/whatis). + +## Pull request requirements + +> [!IMPORTANT] +> Every pull request must include a change log entry. + +Before submitting your pull request, ensure you have met the following requirements. + +1. **Add a changelog entry to `CHANGES.rst`** - This is required and enforced by CI +2. Add a test which proves your fix and make it pass +3. Add yourself to `docs/credits.rst` + +### Changelog entry format + +Add your entry under the appropriate section in `CHANGES.rst`: + +- **Minor changes:** For small improvements, refactoring, documentation updates +- **Breaking changes:** For changes that break existing API +- **New features:** For new functionality +- **Bug fixes:** For bug fixes and error corrections + +Example: + +``` +Minor changes: + +- Fix issue with timezone parsing in special cases. See `Issue XXX `_. +``` + +## Setup for development + +If you would like to setup icalendar to contribute changes, the [Installation Section](https://icalendar.readthedocs.io/en/latest/install.html) should help you further. \ No newline at end of file diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst deleted file mode 100644 index 2ed2dee..0000000 --- a/CONTRIBUTING.rst +++ /dev/null @@ -1,49 +0,0 @@ -You want to help and contribute? Perfect! -========================================= - -These are some contribution examples ------------------------------------- - -- Reporting issues to the bugtracker. - -- Submitting pull requests from a forked icalendar repo. - -- Extending the documentation. - -- Sponsor a Sprint (https://plone.org/events/sprints/whatis). - - -Pull Request Requirements -------------------------- - -**Important:** Every pull request must include a changelog entry, or it will fail CI checks. - -Before submitting your PR, ensure you have: - -1. **Add a changelog entry to ``CHANGES.rst``** - This is required and enforced by CI -2. Add a test which proves your fix and make it pass -3. Add yourself to ``docs/credits.rst`` - -Changelog Entry Format -~~~~~~~~~~~~~~~~~~~~~ - -Add your entry under the appropriate section in ``CHANGES.rst``: - -- **Minor changes:** For small improvements, refactoring, documentation updates -- **Breaking changes:** For changes that break existing API -- **New features:** For new functionality -- **Bug fixes:** For bug fixes and error corrections - -Example:: - - Minor changes: - - - Fix issue with timezone parsing in special cases. See `Issue XXX `_. - -Setup for Development ---------------------- - -If you would like to setup icalendar to -contribute changes, the `Installation Section -`_ -should help you further. diff --git a/README.rst b/README.rst index 7b0944b..74f3344 100644 --- a/README.rst +++ b/README.rst @@ -187,7 +187,7 @@ Further Reading You can find out more about this project: -* `Contributing`_ - **Note: All PRs must include a changelog entry** +* `Contributing`_ * `Changelog`_ * `License`_