From 79dc722072933d45061892995f8b33d46b677956 Mon Sep 17 00:00:00 2001 From: Lee Miller Date: Sat, 17 Sep 2022 05:21:52 +0300 Subject: [PATCH] Remove mention of dead tip4commit and unused Fabric in the PR template and move it to .github dir. --- .../PULL_REQUEST_TEMPLATE.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) rename PULL_REQUEST_TEMPLATE.md => .github/PULL_REQUEST_TEMPLATE.md (73%) diff --git a/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md similarity index 73% rename from PULL_REQUEST_TEMPLATE.md rename to .github/PULL_REQUEST_TEMPLATE.md index c820c50d..fb735a84 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,21 +1,18 @@ ## Repository contributions to the PyBitmessage project -- You can get paid for merged commits if you register at [Tip4Commit](https://tip4commit.com/github/Bitmessage/PyBitmessage) - ### Code - Try to refer to github issue tracker or other permanent sources of discussion about the issue. -- It is clear from the diff *what* you have done, it may be less clear *why* you have done it so explain why this change is necessary rather than what it does +- It is clear from the diff *what* you have done, it may be less clear *why* you have done it so explain why this change is necessary rather than what it does. ### Documentation -- If there has been a change to the code, there's a good possibility there should be a corresponding change to the documentation -- If you can't run `fab build_docs` successfully, ask for someone to run it against your branch +Use `tox -e py27-doc` to build a local copy of the documentation. ### Tests - If there has been a change to the code, there's a good possibility there should be a corresponding change to the tests -- If you can't run `fab tests` successfully, ask for someone to run it against your branch +- To run tests locally use `tox` or `./run-tests-in-docker.sh` ## Translations