contributing.md

Contributing

You can contribute by:

1. Filing a bug report or feature request in an issue.
2. Suggesting a change via a pull request.

Contributors

When you contribute, please add your name to the DESCRIPTION file here:

https://github.com/r-transit/tidytransit/blob/master/DESCRIPTION#L6-L15

Issues

When filing an issue, the most important thing is to include a minimal reproducible example so that we can quickly verify the problem, and then figure out how to fix it. There are three things you need to include to make your example reproducible: required packages, data, code.

Pull requests

To contribute a change to tidytransit, you follow these steps:

1. Create a branch in git and make your changes.
2. Push branch to github and issue pull request (PR).
3. Discuss the pull request.
4. Iterate until either we accept the PR or decide that it's not a good fit.