DRAFT of development process for discussion.

Although it turns out that cross repo refs aren’t really necessary, I have nevertheless recommended them, and updated the docs to reflect this, since there are some rare edge cases where they are preferable.

From: Andre <notifications@github.com<mailto:notifications@github.com>>
Reply-To: cellml/libcellml <reply@reply.github.com<mailto:reply@reply.github.com>>
Date: Tuesday, 9 September 2014 9:28 am
To: cellml/libcellml <libcellml@noreply.github.com<mailto:libcellml@noreply.github.com>>
Cc: Randall Britten <r.britten@auckland.ac.nz<mailto:r.britten@auckland.ac.nz>>
Subject: Re: [libcellml] DRAFT of development process for discussion. (#17)


In docs/source/devProcess.rst:

> +   * The branch label name should be short but descriptive, and it is usually best to suffix it with two digits, "01" for the first time the label is used, and sequential numbering thereafter.
> +
> +#. Create a pull request
> +
> +Guidelines:
> +   * Commit often
> +   * Strive for each small simple logical change, preferably self contained.
> +   * Use interactive git change staging if necessary to convert edits that comprise multiple changes into separate commits. Git makes this really easy.
> +   * Push almost as often as you commit
> +   * Make commit messages as useful as possible.
> +
> +   * Committing message structure guidelines:
> +
> +     * First line is a brief summary.
> +     * Optional: Leave second line blank, and then provide more details.
> +     * Mention any relevant issue numbers (e.g. use "#3593" to refer to issue number 3593)


might be better to encourage Cross-Repository Issue References (https://github.com/blog/967-github-secrets) so that the generated links will work even before the code is merged into the primary repository. Will even work for closing issues (https://github.com/blog/1439-closing-issues-across-repositories) which will help developers/users see that code fixing a given issue is available even if it hasn't been merged in - at least for those with permission to close issues.

—
Reply to this email directly or view it on GitHub<https://github.com/cellml/libcellml/pull/17/files#r17268340>.