Update docs [skip ci]
This commit is contained in:
parent
39c3c4c16a
commit
0d204c7ae6
2
.github/pull_request_template.md
vendored
2
.github/pull_request_template.md
vendored
|
@ -4,6 +4,6 @@ Please answer the following questions and leave the below in as part of your PR.
|
||||||
|
|
||||||
- [ ] This PR corresponds to an [issue with a clear problem statement](https://github.com/babashka/scittle/blob/main/doc/dev.md#start-with-an-issue-before-writing-code).
|
- [ ] This PR corresponds to an [issue with a clear problem statement](https://github.com/babashka/scittle/blob/main/doc/dev.md#start-with-an-issue-before-writing-code).
|
||||||
|
|
||||||
- [ ] This PR contains a [test](https://github.com/babashka/scittle/blob/main/doc/dev.md#tests) to prevent against future regressions
|
<!-- - [ ] This PR contains a [test](https://github.com/babashka/scittle/blob/main/doc/dev.md#tests) to prevent against future regressions -->
|
||||||
|
|
||||||
- [ ] I have updated the [CHANGELOG.md](https://github.com/babashka/scittle/blob/main/CHANGELOG.md) file with a description of the addressed issue.
|
- [ ] I have updated the [CHANGELOG.md](https://github.com/babashka/scittle/blob/main/CHANGELOG.md) file with a description of the addressed issue.
|
||||||
|
|
12
doc/dev.md
12
doc/dev.md
|
@ -17,10 +17,10 @@ Post a corresponding PR with the smallest change possible to address the
|
||||||
issue. Then we discuss the PR, make changes as needed and if we reach an
|
issue. Then we discuss the PR, make changes as needed and if we reach an
|
||||||
agreement, the PR will be merged.
|
agreement, the PR will be merged.
|
||||||
|
|
||||||
### Tests
|
<!-- ### Tests -->
|
||||||
|
|
||||||
Each bug fix, change or new feature should be tested well to prevent future
|
<!-- Each bug fix, change or new feature should be tested well to prevent future -->
|
||||||
regressions.
|
<!-- regressions. -->
|
||||||
|
|
||||||
### Force-push
|
### Force-push
|
||||||
|
|
||||||
|
@ -37,11 +37,11 @@ reasons:
|
||||||
|
|
||||||
## Developing
|
## Developing
|
||||||
|
|
||||||
Run `bb dev` to start shadow-cljs compilation in watch mode. Then run `node out/nbb_main.js` to invoke nbb.
|
Run `bb dev` to start shadow-cljs compilation in watch mode.
|
||||||
|
|
||||||
## Testing
|
<!-- ## Testing -->
|
||||||
|
|
||||||
You can run tests using `bb run-tests` and `bb run-integration-tests`.
|
<!-- You can run tests using `bb run-tests` and `bb run-integration-tests`. -->
|
||||||
|
|
||||||
## Release
|
## Release
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue