Fixing prplwrt bugs
Fixing bugs in prplWrt is straightforward and follows a pretty standard Github reporting model. The process should go as follows:
- 1 Is the bug reported yet?
- 2 Fork from the prplwrt Repository
- 3 Fix the bug
- 4 Tell us what you did
- 5 Submit a pull request
- 6 The community decides on whether to accept your pull request
- 7 Celebrate!
Is the bug reported yet?
Fork from the prplwrt Repository
Fork the prplwrt repository through the Github website
Fix the bug
Edit the code as necessary to fix the bug. Make sure to follow the coding conventions for prplwrt.
Tell us what you did
When you commit, make sure to write a quick description of the work you did. As part of that, make sure you follow the next two guidelines:
Tell us the issue it closes
Github issues supports issues being closed automatically as part of a commit. To support that just add the phrase Closes #n where n is the number of the Github issue you're fixing. For example, if you're fixing issue number 3, add Closes #3 to your commit message.
Sign your work
To help us keep track of who is contributing patches to prplwrt, we use a "sign-off" procedure on code changes. The sign-off is a simple line at the end of the explanation for the patch, which certifies that you wrote it or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: if you can certify the below:
By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
Then you just add a line to your commit message saying:
Signed-off-by: Random J Developer <email@example.com>
using your real name.
If, for personal safety reasons, you cannot use your real name, please contact prpl Community Manager Eric Schultz before submitting your pull request; an alternate procedure will be used.
Submit a pull request
Send a pull request to the prplwrt Github page. Make sure to provide a detailed description of your work; we love what you've done and the committers want to understand it.
Answer any questions on the pull request and make changes as necessary
It's very common for other PEG participants to have questions or concerns about your changes. This is totally normal; very few changes to a project are perfect the first time. Answer the questions as best you can and it's okay to ask other folks questions too.
If you're asked to make changes, follow the same process as before. Make sure to follow the "sign-off" procedure for additional commits add to your pull-request.
The community decides on whether to accept your pull request
For your patch to be merged, there will need to be at least three +1 votes and no -1 votes (or any -1 votes have been rescinded). The pull request needs to have been open for at least 72 hours. If all those conditions are true, a committer will merge the pull request. If it hasn't been merged, ask a committer to merge it on your behalf.
An exception to this process occurs for feature branches where the pull request is coming from a committer. In that case, the committer may merge the pull request immediately. The merge may be reverted later after a review as part of the Merge-then-review system
You're now an official code contributor to prplwrt. We're excited to have you involved!