diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index ad24b5f..97bf79b 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -4,31 +4,8 @@ ### What is the current bug behavior? -(What actually happens) - ### What is the expected correct behavior? -(What you should see instead) - ### Relevant logs and/or screenshots ### Possible fixes suggested remediation - -### Assignees and labels - -(delete as applicable) - -~bug ~confirmed ~regression ~suggestion - -~blocker ~major ~minor - -~tablet ~mobile ~tv - -~ios9 ~ios10 ~ios11 - -%@ms - -/cc @Dev /assign @Tester - -* [ ] Patched -* [ ] Verified patch diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index f649a3a..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,40 +0,0 @@ -A similar PR may already be submitted! -Please search among the Pull requests before creating one. - -Thanks for submitting a pull request! Please provide enough information so that others can review your pull request: - -For more information, see the [CONTRIBUTING](/.github/CONTRIBUTING.md) readme. - - -**Summary** - - - -This PR fixes/implements the following **bugs/features** - -* [ ] Bug 1 -* [ ] Bug 2 -* [ ] Feature 1 -* [ ] Feature 2 -* [ ] Breaking changes - - - -Explain the **motivation** for making this change. What existing problem does the pull request solve? - - - -**Test plan (required)** - -Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI. - - - -**Code formatting** - - - -**Closing issues** - - -Fixes # diff --git a/CLA.rst b/CLA.rst deleted file mode 100644 index ba6396d..0000000 --- a/CLA.rst +++ /dev/null @@ -1,12 +0,0 @@ - -# Contributor agreement - -By contributing any improvement, modification, or change to this project, I hereby certify that: - -(a) The contribution was authored or created in whole or in part by me and I have the full and unrestricted ownership right and title to submit the contribution under the MIT license; or - -(b) The contribution is based upon previously authored work that, to the best of my knowledge, is licensed appropriately under an open source license and I have the full and unrestricted right under that open source license to submit that work with modifications, whether created in whole or in part by me, under the MIT license; or - -(c) The contribution was lawfully provided to me by a licensed third-party who certified (a), (b) or (c) and I have not modified the contribution. - -I understand and agree that the contents of this project and the contents of this contribution are considered to be part of the public record and that a record of the contribution (including all personal information I submit with it) shall be maintained indefinitely and may be redistributed to third-parties consistent with this terms of this project or the open source license(s) involved. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 248fdc7..1896e47 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,22 +1,8 @@ -# Contribution Guidelines -Private Internet Access welcomes community contributions, and are always looking for ways in which to improve. Please take a look at our contribution guidelines, and get involved with the PIA community. +## Contributing -## Bugs and Issues -Have you found a bug? Is our software behaving in an unexpected way? Please check the open issues for duplicates -- perhaps a fix is already in development, or maybe a solution has already been published. -If not then please submit a bug report using our [template](/.github/ISSUE_TEMPLATE.md) - -## Feature Requests -Feature requests can also be submitted as issues. We’d be grateful if you checked for duplicates also before submitting a feature request. - -## Working with our Code -* Fork the repository. Make sure to keep your repository synced with the source repo. -* When you are ready to start working on a new feature, cut a new branch from “develop” with the prefix “feature/” (e.g. “feature/name-of-feature”). -* Refer to the [README](/README.md) for instructions on how to install and build. - -## Making Pull Requests -* Sync the develop branch in your fork with the develop branch in the source repo. -* Make your pull request from “feature” in your fork to “develop” in the source. -* Use short and concise commit messages. -* Lint your code before committing and making a pull request. -* Write unit tests for new features and make sure all tests are passing. -* If your pull request contains multiple commits or commits that are not meaningful, consider squashing them. +- Use imperative commit messages. + - GOOD: "Add new feature" + - BAD: "Added new feature" +- Rebase your branch to `master` and possibly squash unrelevant commits. +- Make sure to pass the unit tests, as long as CI doesn't automate them yet. +- Submit the PR.