dsp-api

dsp-api copied to clipboard

I would like to suggest the following convention. We already do this more or less. But if it is written down somewhere, then new developers can be quickly instructed:

• For each contribution (bugfix, feature, etc.), there must be a ticket (GitHub issue) with a short descriptive name, e.g., "Respect host/port configuration setting"
• Work should happen in a branch named "wip/ISSUE-DESCRIPTION", e.g., "wip/32-respect-host-and-port"
• The issue should be assigned to a milestone
• The description of the PR should contain the summary of the PR and the string resolves #32, which makes sure that the issue is closed when the PR is merged into develop.
• The PR should be merged as a squash and commit
• The PR should NOT be added to a milestone.
• The issue is the place to discuss if an issue makes sense and what a feature should or should not do. This is where we describe the motivation and any decisions.
• The PR is the place for testing and code review. Very technical and geeky.

We could add this to the end of the README.md.