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

Add link to PR checklist in CONTRIBUTING.md #753

Merged
merged 2 commits into from
Feb 3, 2015
Merged

Conversation

PamelaM
Copy link
Contributor

@PamelaM PamelaM commented Feb 3, 2015

Since github adds the link to CONTRIBUTING.md when creating pull requests, I thought that the CONTRIBUTING.md should call out the checklist specifically. An even cooler approach would be to modularize the text of the checklist block and include it in CONTRIBUTING.md and the docs, but my docs build foo isn't there yet.

  • Is it mergable?
  • Did it pass the tests?
  • If it introduces new functionality in scripts/ is it tested?
    Check for code coverage.
  • Is it well formatted? Look at make pep8, make diff_pylint_report,
    make cppcheck, and make doc output. Use make format and manual
    fixing as needed.
  • Did it change the command-line interface? Only additions are allowed
    without a major version increment. Changing file formats also requires a
    major version number increment.
  • Is it documented in the ChangeLog?
  • Was a spellchecker run on the source code and documentation after
    changes were made?

@ged-jenkins
Copy link

Can one of the admins verify this patch?

1 similar comment
@ged-jenkins
Copy link

Can one of the admins verify this patch?

@luizirber
Copy link
Member

jenkins, ok to test

@mr-c
Copy link
Contributor

mr-c commented Feb 3, 2015

Awesome, thanks @PamelaM !

mr-c added a commit that referenced this pull request Feb 3, 2015
Add link to PR checklist in CONTRIBUTING.md
@mr-c mr-c merged commit c236014 into dib-lab:master Feb 3, 2015
@mr-c
Copy link
Contributor

mr-c commented Feb 3, 2015

@PamelaM, Congratulations on your first commit to the khmer project! Your name will be included in the release notes for the next version and you'll be listed amongst our other contributors in the next software release paper.

@PamelaM
Copy link
Contributor Author

PamelaM commented Feb 3, 2015

Seems like a lot of credit for a non-code change :) but thanks

pam

On Tue, Feb 3, 2015 at 4:59 PM, Michael R. Crusoe notifications@github.com
wrote:

@PamelaM https://github.com/PamelaM, Congratulations on your first
commit to the khmer project! Your name will be included in the release
notes for the next version and you'll be listed amongst our other
contributors in the next software release paper.


Reply to this email directly or view it on GitHub
#753 (comment).

Pamela McA'Nulty
Chief Architect
Addgene
1 Kendall Square, Suite B7102
Cambridge, MA 02139-1666
office: 617-225-9000 x121
www.addgene.org

Follow Addgene on Facebook https://www.facebook.com/addgene, Twitter
https://twitter.com/Addgene, or our Blog http://blog.addgene.org/

@mr-c
Copy link
Contributor

mr-c commented Feb 3, 2015

That's how we roll :-)

On Tue Feb 03 2015 at 11:01:06 PM PamelaM notifications@github.com wrote:

Seems like a lot of credit for a non-code change :) but thanks

pam

On Tue, Feb 3, 2015 at 4:59 PM, Michael R. Crusoe <
notifications@github.com>
wrote:

@PamelaM https://github.com/PamelaM, Congratulations on your first
commit to the khmer project! Your name will be included in the release
notes for the next version and you'll be listed amongst our other
contributors in the next software release paper.


Reply to this email directly or view it on GitHub
#753 (comment).

Pamela McA'Nulty
Chief Architect
Addgene
1 Kendall Square, Suite B7102
Cambridge, MA 02139-1666
office: 617-225-9000 x121
www.addgene.org

Follow Addgene on Facebook https://www.facebook.com/addgene, Twitter
https://twitter.com/Addgene, or our Blog http://blog.addgene.org/


Reply to this email directly or view it on GitHub
#753 (comment).

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

Successfully merging this pull request may close these issues.

4 participants