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: update readme #39

Merged
merged 13 commits into from
Feb 28, 2018
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -140,7 +140,7 @@ HMMs were trained from KO protein sets, based on KEGG Release 58.1. Multisequenc

Anybody is welcome to contribute to the development of RAVEN Toolbox, but please abide by the following guidelines.

When making _any_ changes to an existing function (`*.m`-file, change the name and date near the bottom of the commented section that is included the beginning of each function. In this section, please specify what each parameter is doing, and what are default settings. Have a look at existing functions to see what style is used.
Each function should start with a commented section describing the function and explaining the parameters. Existing functions can clarify what style should be used. When making *any* changes to an existing function (`*.m`-file), change the date and name of developer near the bottom of this commented section.

### Urgent bugfix
* When fixing a bug in an existing function, make a separate branch from `master` and name the branch after the function you are fixing.