Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Describe how to behave as a contributor #258

Closed
pietermarsman opened this issue Jul 8, 2019 · 3 comments
Closed

Describe how to behave as a contributor #258

pietermarsman opened this issue Jul 8, 2019 · 3 comments
Labels
type: documentation Related to the documentation

Comments

@pietermarsman
Copy link
Member

I think it would help future contributors to participate if it is clear what we expect from them and what they can expect from the project. I'm thinking of the following:

  • Use issues to point to problems
    • Discuss possible improvements in an issue
    • Include a minimal reproducible example if possible
    • Include the package version
  • Use pull requests to fix problems
    • So no PR without an issue
    • Point your PR to the develop branch
    • PR's should be PEP8 compliant
    • PR's should create or update PEP257 docstrings if necessary.
    • PR's should include testing of the minimal reproducing examle if possible
    • PR's should work with python2 and python3 (for now)
    • PR's should succesfully run test-suite (on travis)
@tataganesh
Copy link
Member

This is great! Thank you @pietermarsman !

@fakabbir
Copy link
Contributor

Maybe this could have directly hit the master branch since CONTRIBUTIONS.md's reference is in master branch and the file is present in develop branch.

@pietermarsman pietermarsman added the type: documentation Related to the documentation label Oct 12, 2019
@pietermarsman
Copy link
Member Author

Fixed by #259 and #304

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Related to the documentation
Projects
None yet
Development

No branches or pull requests

3 participants