Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
p-zielinski committed Oct 17, 2023
1 parent 9248d4c commit 74af909
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,13 +106,17 @@ Good practices:
- Copy `.env.example` to `.env` and add to this file your personal API Key created in readme.io: `dashboard` > `configuration` > `API Keys`

### Development process
- For each change / pull request, create your copy of the current documentation, where you will test changes.
- Create your own branch from `master`,
- Create a draft pull request
- Make changes in the repository following patterns and good practices.
- Run `npm run manage-project -- --vt={your name}-{pull request number or tag number} --create` - this will create new version project with your tag number.
- Run `npm run manage-project -- --vt={your name}-{pull request number} --create` - this will create new version project with your tag number.
- Visit url provided at the end of the script run to test changes using preview on readme.io
- If you need to make a change:
- Do changes...
- Run `npm run manage-project -- --vt={your name}-{pull request number or tag number} --update`- this will update your version.
- Run `npm run manage-project -- --vt={your name}-{pull request number} --update`- this will update your version.
- Test changes using preview on readme.io
- If needed - **REPEAT**
- If changes are fine, then:
- Add a note in the changelog.
- `git commit; git push`
Expand Down

0 comments on commit 74af909

Please sign in to comment.