-
Notifications
You must be signed in to change notification settings - Fork 15
Description
You've done some work towards another issue but haven't finished it yet. You want to integrate your changes into the rest of the project with a pull request before you continue your work on the issue. This will mean other contributors can see your changes in their copy of the code, and can take your work into account in anything they're doing. This is great!
Please complete the link below to link this to the issue you're working on. Give this new issue a name that describes the changes you will include in a pull request.
Split from:
Pull requests for unfinished changes
Any changes you make must still pass all tests and linting. Your code in progress should still follow our conventions, and should still include automated test coverage following our test strategy.
If your changes affect the behaviour of the system in incomplete ways, or may cause confusion over an incomplete feature, we may still be able to accommodate this. You could avoid connecting your new code to the rest of the system temporarily, or include configuration such that the new behaviour is disabled by default.
Explanation
For tracking reasons, we want each pull request to be linked to an issue that it resolves. For an issue that's still in progress, please don't link a pull request to the original because that would trigger GitHub to close the original issue when the pull request is merged. Instead, you can link your pull request to a new issue that's split from the original.
As an alternative to this template, you could consider raising a normal feature issue, with a link to the original in the background section. You can use a "Split from:" link as shown above. That gives you an opportunity to include more information about the intention and any analysis.