Skip to content

Fix #85: Improve contribution section #147

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Oct 1, 2019
Merged

Fix #85: Improve contribution section #147

merged 2 commits into from
Oct 1, 2019

Conversation

tomschr
Copy link
Member

@tomschr tomschr commented Oct 1, 2019

This PR fixes #85 and closes #115 and contains the following changes:

This is a mostly a complete rewrite, sometimes drastically, with the following ideas and changes in mind:

  • Add a brief workflow, starting from forking, cloning, creating a branch, and opening a pull request.
  • Use "procedure style" and use active voice to make reader aware of an action
  • Remove intersphinx section of matplotlib (not used) in docs/conf.py (it seems just a leftover). Makes build faster.

I'm sure, I haven't addressed all ideas, so I see it as a first draft. We can always improve. So here are some of my questions and comments:

  • Not sure if this chapter is a bit "overwhelming". Maybe we don't need to explain how to fork? To clone? To create pull request? Are these a given? Or should we address also developers who don't frequently work with GitHub and Git?
  • Should we shorten the procedure?
  • I took the liberty to give some recommendations, although I wasn't completely sure if these are shared by other project members. It wasn't my intention to force others, just giving some useful tips that I think are "good practices". Feel free to correct them if you don't like them.
  • The first paragraph tries to be a bit more informal and personal to motivate our readers to contribute. I'm not sure if this is adequate.
  • I haven't covered the coverage topic yet. I thought it would be useful to just cover the basic stuff and bring this PR out of the door. 😉

Feel free to send me your ideas and let me know what you think. :-)

tomschr and others added 2 commits October 1, 2019 08:44
@tomschr
Fix python-semver#85: Improve contribution section
c32cfb7 
Closes python-semver#115 too.

This is a mostly a complete rewrite with the following ideas
and changes in mind:

* Add a brief workflow, starting from forking, cloning,
  creating a branch, and opening a pull request.
* Use "procedure style" and use active voice to make reader
  aware of an action
* Remove intersphinx section for matplotlib (not used) in
  docs/conf.py
@tomschr
Fix flake8 W391 for Python 3.4
bc7d200 
Error message was:
W391 blank line at end of file
@tomschr tomschr mentioned this pull request Oct 1, 2019
Closed
@s-celles s-celles merged commit 7e48417 into python-semver:master Oct 1, 2019
@s-celles
Copy link
Member

s-celles commented Oct 1, 2019

Thanks @tomschr Great contribution about how to contribute! 😄 👍 👍 👍

@tomschr tomschr deleted the feature/85-doc-contribute branch October 1, 2019 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Bad link to tox Improve "how to contribute" section
2 participants
@tomschr @s-celles