forked from pnp/pnpjs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2977bda
commit 539a654
Showing
1 changed file
with
10 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,17 @@ | ||
# Contributing Guidance | ||
## Contributing Guidance - v2 | ||
|
||
* Target your pull requests to the **dev-v2** branch | ||
* Target your pull requests to the **version-2** branch | ||
* Add/Update any docs articles related to your changes | ||
* Include a test for any new functionality and ensure all existing tests are passing by running `npm test` | ||
* If you are fixing a but, include a test that would have caught the bug you are fixing | ||
* If you are fixing a bug, include a test that would have caught the bug you are fixing | ||
* Ensure tslint checks pass by typing `npm run lint` | ||
* Keep your PRs as simple as possible and describe the changes to help the reviewer understand your work | ||
* If you have an idea for a larger change to the library please [open an issue](https://github.com/pnp/pnpjs/issues) and let's discuss before you invest many hours - these are very welcome but want to ensure it is something we can merge before you spend the time :) | ||
|
||
> If you need to target a PR for version 1, please target the "version-1" branch | ||
|
||
## Contributing Guidance - v1 | ||
|
||
* Target your pull requests to the **version-1** branch | ||
* Ensure tslint checks pass by typing `gulp lint` | ||
* Keep your PRs as simple as possible and describe the changes to help the reviewer understand your work | ||
* If you have an idea for a larger change to the library please [open an issue](https://github.com/pnp/pnpjs/issues) and let's discuss before you invest many hours - these are very welcome but want to ensure it is something we can merge before you spend the time :) |