Skip to content

Commit 7c14bbb

Browse files
authored
feat: Add npm relative information to readme file (#90)
* feat: Add information about readme in the github default PR message * feat: Add information about unpublishing npm version in the readme * feat: Move information about breaking changes * feat: Move information about conventionnal commits
1 parent 2ffafff commit 7c14bbb

2 files changed

Lines changed: 11 additions & 2 deletions

File tree

PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
<!-- If your PR is related to a RFC, please add `Closes #<issue number>` to link the PR to the issue and close it automatically when the PR is merged -->
22

3-
<!-- We use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) to automate the release process. Please follow the commit message format described in the link above. Lerna will automatically generate the changelog for each package based on the commit messages since the last version. -->
3+
<!-- We use conventional commits to automate the release process. Please read the [Readme](https://github.com/bamlab/react-native-project-config/blob/main/README.md) for more information. Please follow the commit message format described in the link above. Lerna will automatically generate the changelog for each package based on the commit messages since the last version. -->

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,12 @@ Here are some useful commands:
3030
- rename the directory of a package: `mv package-my-config new-directory-name && yarn lerna bootstrap`,
3131
- run a script `do-something` that exists in at least one package: `yarn lerna run do-something` (this will try to run the script in all packages in which it is defined).
3232

33+
## Conventional commits
34+
35+
We use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) to automate the release process.
36+
37+
> If you add a new rule to a config, this is a breaking change, because it could make the CI fail on projects that use the plugin. The commit name where you add the new rule needs to follow this patern `BREAKING CHANGE : the description of your commit`
38+
3339
## Publishing a new version of a package
3440

3541
The publication is done automatically by this [Github Workflow](https://github.com/bamlab/react-native-project-config/blob/main/.github/workflows/publish.yml) when a new tag is pushed to the repository.
@@ -55,7 +61,10 @@ Changes:
5561

5662
It will then push a tagged commit `chore(release): Publish` which will then trigger the Github Workflow to publish the new version of each package to NPM.
5763

58-
> If you add a new rule to a config, this is a breaking change, because it could make the CI fail on projects that use the plugin. The commit name where you add the new rule needs to follow this patern `BREAKING CHANGE : the description of your commit`
64+
## Unpublish a package version
65+
66+
If you want to unpublish a package, you have to be contributor of @bam.tech/eslint-plugin (in this case for the eslint plugin). Use the following commad :
67+
`npm unpublish @bam.tech/eslint-plugin@X.Y.Z`
5968

6069
## Running commands
6170

0 commit comments

Comments
 (0)