kopia lustrzana https://github.com/collective/icalendar
Address stevepiercy review feedback
- Move CONTRIBUTING.md to root and merge with .rst content - Update PR template with headings, remove HTML comments - Fix changelog entry wording - Revert redundant README change - Remove duplicate contributing filespull/892/head
Sashank
rodzic
cc5dc2adea
commit
e9fcc09776
|
|
@ -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.
|
||||
|
|
@ -1,17 +1,15 @@
|
|||
<!--
|
||||
Please add an entry to the CHANGES.rst file as described in https://icalendar.readthedocs.io/en/latest/contributing.html
|
||||
-->
|
||||
## 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:**
|
||||
<!-- Write a description of the fixes or improvements -->
|
||||
## 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:**
|
||||
<!-- Screenshots, links to documentation, etc. -->
|
||||
## Additional information
|
||||
Upload screenshots, videos, links to documentation, or any other relevant information.
|
||||
|
|
@ -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 <https://github.com/collective/icalendar/issues/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 <https://github.com/collective/icalendar/issues/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 <https://github.com/collective/icalendar/issues/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 <https://github.com/collective/icalendar/issues/890>`_.
|
||||
- Make coverage submission optional for CI
|
||||
|
||||
Breaking changes:
|
||||
|
|
|
|||
|
|
@ -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 <link>`_.
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
|
@ -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 <link>`_.
|
||||
|
||||
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.
|
||||
|
|
@ -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`_
|
||||
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue