Skip to content

Commit

Permalink
Updating documentation / PR template to target **version-3** of PnPjs
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelmaillot committed Mar 27, 2023
1 parent 4ba811b commit dbcea83
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ fixes #X, mentioned in #Y
*You can delete this section when you are submitting the pull request.*

* Please update this PR information accordingly. We'll use this as part of our release notes in monthly communications.
* Please target your PR to "version-2" branch for v2 changes and "version-1" branch for v1 changes
* Please target your PR to "version-3" branch for v3 changes, "version-2" branch for v2 changes and "version-1" branch for v1 changes
* Please ensure you have updated any associated docs files based on your code changes
* Please ensure you have updated/added tests to cover your change.
* If you are fixing a bug include a test that would have caught the bug you are fixing
Expand Down
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
## Contributing Guidance - v3

* Target your pull requests to the **version-3** 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 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 :)

## Contributing Guidance - v2

* Target your pull requests to the **version-2** branch
Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/custom-bundle.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ Scenarios could include:

### Webpack

You can see/clone a [sample project of this example here](https://github.com/pnp/pnpjs/tree/version-2/samples/custom-bundle-webpack).
You can see/clone a [sample project of this example here](https://github.com/pnp/pnpjs/tree/version-3/samples/custom-bundle-webpack).
2 changes: 1 addition & 1 deletion docs/contributing/pull-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Pull requests may be large or small - adding whole new features or fixing some misspellings. Regardless, they are all appreciated and help improve the library for everyone! By following the below guidelines we'll have an easier time merging your work and getting it into the next release.

* Target your pull requests to the **version-2** branch
* Target your pull requests to the **version-3** branch
* Add/Update any relevant docs articles in the relevant package's docs folder related to your changes
* Include a test for any new functionality and ensure all existing tests are passing by running `npm test`
* Ensure linting checks pass by typing `npm run lint`
Expand Down
4 changes: 2 additions & 2 deletions tools/buildsystem/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Configuration is driven entirely by the `buildsystem-config.ts` file, which uses

For each of the three roles, build, package, and publish there exists an interface defining what it should contain. You can have multiple configurations per role, differentiated by name.

> The definitions for the [configuration options](https://github.com/pnp/pnpjs/blob/version-2/tools/buildsystem/src/config.ts) are available in the source. It is intended your buildsystem.config.ts export a valid `ConfigCollection`;
> The definitions for the [configuration options](https://github.com/pnp/pnpjs/blob/version-3/tools/buildsystem/src/config.ts) are available in the source. It is intended your buildsystem.config.ts export a valid `ConfigCollection`;
For an [example buildsystem-config](https://github.com/pnp/pnpjs/blob/version-2/buildsystem-config.ts) please see the one used by PnPjs within this repo.
For an [example buildsystem-config](https://github.com/pnp/pnpjs/blob/version-3/buildsystem-config.ts) please see the one used by PnPjs within this repo.

## Run

Expand Down

0 comments on commit dbcea83

Please sign in to comment.