Require each pulpcore feature or bugfix to come with a functional test
Open
Nobody has claimed this yet.
Documentation
Task
- Dominant language
- Python
- Stars
- 598
- Forks
- 168
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 86
Description
Author: @bmbouter (bmbouter)
Redmine Issue: 7436, https://pulp.plan.io/issues/7436
Background
It would be great if each fix or feature came with a test asserting that fix/feature is working with the same commit as the fix or feature. This was originally proposed on pulp-dev here
Todo
- Revise the Functional Tests section here to indicate a functional test is a requirement: https://docs.pulpproject.org/pulpcore/contributing/tests.html#functional-tests
- Include writing a test in the workflow here: https://docs.pulpproject.org/pulpcore/contributing/index.html#workflow
- Revise this page to be clearer about the functional test requirement: https://docs.pulpproject.org/pulpcore/contributing/pull-request-walkthrough.html#checklist
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the Functional Tests, workflow, and pull-request checklist pages linked in the issue. Update each page so the functional-test requirement is clear and consistently included in the contributor workflow. Done means all three sections explicitly describe the requirement without conflicting guidance.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100