Skip to content

started editing docs to add "how to get help"#942

Merged
mr-c merged 20 commits into
dib-lab:masterfrom
safay:fix/296_how-to-get-help
Apr 14, 2015
Merged

started editing docs to add "how to get help"#942
mr-c merged 20 commits into
dib-lab:masterfrom
safay:fix/296_how-to-get-help

Conversation

@safay

@safay safay commented Apr 14, 2015

Copy link
Copy Markdown

draft edits for "Supportability tasks #296," how to ask for help

@ged-jenkins

Copy link
Copy Markdown

Can one of the admins verify this patch?

1 similar comment
@ged-jenkins

Copy link
Copy Markdown

Can one of the admins verify this patch?

@safay

safay commented Apr 14, 2015

Copy link
Copy Markdown
Author

@mr-c:
I need some clarification about what you mean by "getting help through github"

@mr-c

mr-c commented Apr 14, 2015

Copy link
Copy Markdown
Contributor

@safay Creating an issue: https://github.com/ged-lab/khmer/issues/new

@safay

safay commented Apr 14, 2015

Copy link
Copy Markdown
Author

@mr-c:
Ah okay, literally reporting an issue. Thanks for the clarification!

@safay

safay commented Apr 14, 2015

Copy link
Copy Markdown
Author
  • 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?

@safay

safay commented Apr 14, 2015

Copy link
Copy Markdown
Author

@mr-c: How's it look? Ready to merge?

Comment thread doc/user/getting-help.rst Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wrap lines at 80 characters, please :-)

@safay

safay commented Apr 14, 2015

Copy link
Copy Markdown
Author

re-wrote google search box from scratch; this is my code

@safay

safay commented Apr 14, 2015

Copy link
Copy Markdown
Author

@mr-c: when you have some time please have a look again; I think this is ready

Comment thread ChangeLog Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please list each file modified :-)

Comment thread doc/user/getting-help.rst Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you drop this para as well?

mr-c added a commit that referenced this pull request Apr 14, 2015
started editing docs to add "how to get help"
@mr-c mr-c merged commit d7d9603 into dib-lab:master Apr 14, 2015
@safay safay deleted the fix/296_how-to-get-help branch April 14, 2015 23:56
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.

3 participants