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

DOC: Updating contributing docs #1052

Merged
merged 3 commits into from Oct 23, 2013

Conversation

Projects
None yet
3 participants
@jseabold
Copy link
Member

commented Aug 19, 2013

Also adds a stub for the 0.6. release notes so we can ask people to fill in as we go this time.

Would be good to get another set of eyes on the minimum requirements for accepting a PR. Anything else?

Hopefully, this ups the ante a bit for getting PRs merged -- mainly focusing more on documentation and editing the release notes. This will improve the quality of the code base and make it easier to just tag and release when ready.


1. `Fork <https://help.github.com/articles/fork-a-repo>`_ the `statsmodels repository <https://github.com/statsmodels/statsmodels>`_ on Github.
2. `Create a new feature branch <http://git-scm.com/book/en/Git-Branching-Basic-Branching-and-Merging>`_
+ Each branch must be self-contained, with a single new feature or bugfix.
+ Patches must always include tests. See our `notes on testing <test_notes.html>`_.

This comment has been minimized.

Copy link
@guyrt

guyrt Aug 28, 2013

Contributor

This link 404ed for me. Looks like it shouldn't be using https.

edit: I meant test_notes.html

This comment has been minimized.

Copy link
@jseabold

jseabold Aug 28, 2013

Author Member

Right. Thanks. This one is malformed too, because it won't expand the sphinx shortcut here.


- **One branch. One feature.** Branches are cheap and github makes it easy to merge and delete branches with a few clicks. Avoid the temptation to lump in a bunch of unrelated changes when working on a feature, if possible. This helps us keep track of what has changed when preparing a release.
- Commit messages should be clear and concise. This means a subject line of less than 80 characters, and, if necessary, a blank line followed by a commit message body. We have an `informal commit format standard <http://statsmodels.sourceforge.net/devel/dev/maintainer_notes.html#commit-comments>`_ that we try to adhere to. You can see what this looks like in practice by ``git log --oneline -n 10``. If your commit references or closes a specific issue, you can close it by mentioning it in the `commit message <https://help.github.com/articles/closing-issues-via-commit-messages>`_. (*For maintainers*: These suggestions go for Merge commit comments too. These are partially the record for release notes.)
- Code submissions must always include tests. See our `notes on testing <http://statsmodels.sourceforge.net/devel/dev/test_notes.html>`_.

This comment has been minimized.

Copy link
@josef-pkt

josef-pkt Oct 22, 2013

Member

maybe tone down the "must" a bit
for example "Code submissions need to have unit tests before they can be merged"

@josef-pkt

This comment has been minimized.

Copy link
Member

commented Oct 22, 2013

looks good to merge, except that I don't like the word "must" when it's based on volunteer work

@josef-pkt

This comment has been minimized.

Copy link
Member

commented Oct 22, 2013

I added milestole 0.6 unless you want to backport

@jseabold

This comment has been minimized.

Copy link
Member Author

commented Oct 23, 2013

Rebased.

jseabold added a commit that referenced this pull request Oct 23, 2013

Merge pull request #1052 from jseabold/contrib-docs
DOC: Updating contributing docs

@jseabold jseabold merged commit f6ea129 into statsmodels:master Oct 23, 2013

1 check was pending

default The Travis CI build is in progress
Details

@jseabold jseabold deleted the jseabold:contrib-docs branch Oct 23, 2013

PierreBdR pushed a commit to PierreBdR/statsmodels that referenced this pull request Sep 2, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.