-
Notifications
You must be signed in to change notification settings - Fork 98
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
40 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# Contributing | ||
|
||
Contributions are mostly welcome, and this document should be kept short not to scare away contributors - and if the length of this text scares you, then I'd rather want you to skip reading and just produce a pull-request in GitHub. | ||
|
||
## Considerations | ||
|
||
* Contributions that break backward compatibility will (generally) not be accepted | ||
* Primary scope of the library is to deal with the CalDAV-protocol. Just consider for a moment if your new feature may fit better into another library, like the icalendar library or the plann tool. | ||
* Workarounds for supporting some quirky CalDAV-server is generally accepted, just be careful that your contribution does not break for other CalDAV-servers. | ||
* If you need to deal with iCalendar payload, new code should do it through the icalendar library. | ||
|
||
## Contribution Procedure | ||
|
||
Consider this procedures to be a more of a guideline than a rigid procedure. Use your own judgement, skip steps you deem too difficult, too boring or that doesn't make sense. If you don't have an account at GitHub, then reach out by email to [email protected] (prepend subject with `caldav:` and my spam filter will let it through). | ||
|
||
* Write up an issue at [GitHub](https://github.com/python-caldav/caldav/issues/new) | ||
|
||
* Create your own [GitHub fork](https://github.com/python-caldav/caldav/fork) | ||
|
||
* Clone locally (`git clone https://github.com/$LOGNAME/caldav`) and run `pytest` for a quick run of the tests. They should pass (you may need to replace `$LOGNAME`). | ||
|
||
* Write up some test code prior to changing the code ("test-driven development" is a good concept) | ||
|
||
* Write up your changes | ||
|
||
* Run `pytest` for a quick run of the tests. They should still pass. | ||
|
||
* Run `tox -e style` to verify a consistent code style (this may modify your code). | ||
|
||
* Consider to write some lines in the documentation and/or examples covering your change | ||
|
||
* Add an entry in the `CHANGELOG.md` file. | ||
|
||
* Create a pull request | ||
``` | ||
## Code of Conduct | ||
I hope it will never be needed, but eventually at some point perhaps some stuff from https://www.contributor-covenant.org/ will be copied in here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters