kopia lustrzana https://github.com/collective/icalendar
Move and rewrite content from `CONTRIBUTING.md` to `docs/contributing.rst`.
rodzic
0b4b6857c6
commit
3f22a295ee
|
@ -1,42 +1,3 @@
|
|||
# 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.
|
||||
See our [contributing guide](https://icalendar.readthedocs.io/en/latest/contributing.html) for complete information on how to contribute to icalendar.
|
||||
|
|
|
@ -1,5 +1,60 @@
|
|||
------------------
|
||||
Contributing
|
||||
------------------
|
||||
============
|
||||
|
||||
.. include:: ../CONTRIBUTING.rst
|
||||
This guide describes how to contribute to icalendar.
|
||||
|
||||
Examples of how to contribute
|
||||
-----------------------------
|
||||
|
||||
- Report issues to the bugtracker.
|
||||
- Submit pull requests from your fork of the icalendar repository.
|
||||
- Extend the documentation.
|
||||
- Sponsor development of icalendar through [Open Collective](https://opencollective.com/python-icalendar).
|
||||
|
||||
|
||||
Pull request requirements
|
||||
-------------------------
|
||||
|
||||
Before submitting your pull request, ensure you have met the following requirements.
|
||||
|
||||
#. Add a changelog entry to :file:`CHANGES.rst`.
|
||||
This is required and enforced by CI.
|
||||
See :ref:`change-log` for details.
|
||||
#. Add a test which proves your fix and passes.
|
||||
#. Run all tests to ensure your changes don't break any existing functionality.
|
||||
#. Add or edit documentation, both as docstrings to be rendered in the API documentation and narrative documentation, as necessary.
|
||||
#. Add yourself to :file:`docs/credits.rst`, if you haven't already done so.
|
||||
|
||||
|
||||
.. _change-log:
|
||||
|
||||
Change log entry format
|
||||
```````````````````````
|
||||
|
||||
Add your entry under the appropriate section in :file:`CHANGES.rst`.
|
||||
|
||||
Minor changes
|
||||
For small improvements, refactoring, and documentation updates.
|
||||
|
||||
Breaking changes
|
||||
For changes that break the existing API.
|
||||
|
||||
New features
|
||||
For new functionality.
|
||||
|
||||
Bug fixes
|
||||
For bug fixes and error corrections.
|
||||
|
||||
Example:
|
||||
|
||||
.. code-block:: rst
|
||||
|
||||
Minor changes:
|
||||
|
||||
- Fix issue with timezone parsing in special cases. See `Issue XXX <link>`_.
|
||||
|
||||
|
||||
Set up for development
|
||||
----------------------
|
||||
|
||||
If you would like to set up icalendar to contribute changes, :doc:`install` should help you further.
|
||||
|
|
Ładowanie…
Reference in New Issue