Skip to content

Latest commit

 

History

History
41 lines (23 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

41 lines (23 loc) · 2.13 KB
Raw

Contributing

Contributions are mostly welcome. 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

  • Create your own GitHub 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

There is some text on https://www.contributor-covenant.org/, please DO reach out at [email protected] if you notice a need for an explicit Code of Conduct.

Specific for this project, we should probably strive not to use too many negative adjectives on server implementations.