Update contribution guidelines
This commit is contained in:
Davide De Rosa
parent
4abc37f417
commit
5f1b08f608
|
|
@ -4,31 +4,8 @@
|
||||||
|
|
||||||
### What is the current bug behavior?
|
### What is the current bug behavior?
|
||||||
|
|
||||||
(What actually happens)
|
|
||||||
|
|
||||||
### What is the expected correct behavior?
|
### What is the expected correct behavior?
|
||||||
|
|
||||||
(What you should see instead)
|
|
||||||
|
|
||||||
### Relevant logs and/or screenshots
|
### Relevant logs and/or screenshots
|
||||||
|
|
||||||
### Possible fixes suggested remediation
|
### 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
|
|
||||||
|
|
|
||||||
|
|
@ -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**
|
|
||||||
|
|
||||||
<!-- Summary of the PR -->
|
|
||||||
|
|
||||||
This PR fixes/implements the following **bugs/features**
|
|
||||||
|
|
||||||
* [ ] Bug 1
|
|
||||||
* [ ] Bug 2
|
|
||||||
* [ ] Feature 1
|
|
||||||
* [ ] Feature 2
|
|
||||||
* [ ] Breaking changes
|
|
||||||
|
|
||||||
<!-- You can skip this if you're fixing a typo or adding an app to the Showcase. -->
|
|
||||||
|
|
||||||
Explain the **motivation** for making this change. What existing problem does the pull request solve?
|
|
||||||
|
|
||||||
<!-- Example: When "Adding a function to do X", explain why it is necessary to have a way to do X. -->
|
|
||||||
|
|
||||||
**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.
|
|
||||||
|
|
||||||
<!-- Make sure tests pass on both Travis and Circle CI. -->
|
|
||||||
|
|
||||||
**Code formatting**
|
|
||||||
|
|
||||||
<!-- See the simple style guide. -->
|
|
||||||
|
|
||||||
**Closing issues**
|
|
||||||
|
|
||||||
<!-- Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such). -->
|
|
||||||
Fixes #
|
|
||||||
12
CLA.rst
12
CLA.rst
|
|
@ -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.
|
|
||||||
|
|
@ -1,22 +1,8 @@
|
||||||
# Contribution Guidelines
|
## Contributing
|
||||||
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.
|
|
||||||
|
|
||||||
## Bugs and Issues
|
- Use imperative commit messages.
|
||||||
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.
|
- GOOD: "Add new feature"
|
||||||
If not then please submit a bug report using our [template](/.github/ISSUE_TEMPLATE.md)
|
- BAD: "Added new feature"
|
||||||
|
- Rebase your branch to `master` and possibly squash unrelevant commits.
|
||||||
## Feature Requests
|
- Make sure to pass the unit tests, as long as CI doesn't automate them yet.
|
||||||
Feature requests can also be submitted as issues. We’d be grateful if you checked for duplicates also before submitting a feature request.
|
- Submit the PR.
|
||||||
|
|
||||||
## 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.
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue