How to format your Pull Requests
Whenever a pull request (PR) is generated, it’s highly recommended for collaborators to include as many of these sections in the PR description.
Why This PR Adds Value
Why did you submit this PR? What are its benefits? - Use Issue Description as inspiration
What This PR Adds
Bullet point list of features - should be descriptive. Mention code variables, file names and/or selectors.
Add a screenshot below of what your changes look like - especially if it changes the UI. Remove this line and add the alt text and image link accordingly. You can also upload images to DagsHub by dragging and dropping (or copying and pasting) the image. You can paste your images in this HackMd file to get the image link if copy-pasting isn’t working.
Screenshot
How This PR Could Be Improved
Improvement Area - Add details of what the improvement is, why it would be an improvement and if there are any blockers or issues preventing you from implementing it (lack of knowledge, isn’t possible, haven’t got to it yet or dependent on another issue (if so link to the issue using
#issue number). This is the place to ask for help if needed. Looking for help from a fellow OmdenaLore member with a specific skill set? Mention it here.
Issue This PR Closes
This will link the PR to the relevant issue so merging the PR with automatically close the issue. Also, it helps others discover which issues have open PRs. Note: Don’t change any of the wording in the line below or it won’t work. (Remove this quote line once you have linked a PR to an issue.
This closes #issue number
You can refer to pull request #57 to see get inspiration on how to write a good PR using this format.