Skip to content

Commit b43f176

Browse files
docs: Adds instructions to CONTRIBUTING for issue reproduction (#5993)
1 parent dd7317c commit b43f176

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ Thank you for filing! Check list:
44
- [ ] Concise, focused, friendly issue title & description.
55
- [ ] A [minimal, reproducible example](http://sscce.org).
66
- [ ] OS and browser versions, if relevant.
7-
- [ ] Is it already fixed in master?
7+
- [ ] Is it already fixed in master? [Instructions](https://github.com/rescript-lang/rescript-compiler/blob/master/CONTRIBUTING.md#debugging-issues-from-ci-builds)

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -403,6 +403,22 @@ To build a new version and release it on NPM, follow these steps:
403403
1. Create a release entry for that tag on the [Github Releases page](https://github.com/rescript-lang/rescript-compiler/releases), copying the changes from `CHANGELOG.md`.
404404
1. Coordinate any forum/blog posts with [@ryyppy](https://github.com/ryyppy).
405405

406+
## Debugging issues from CI builds
407+
408+
To reproduce issues, it can be helpful to the team to install a specific version of the compiler. To do so:
409+
410+
1. Go to [Actions CI for master](https://github.com/rescript-lang/rescript-compiler/actions/workflows/ci.yml?query=branch%3Amaster)
411+
- If you need a specific branch, select a different one to filter to in the GitHub UI.
412+
1. Select a specific run (likely the latest)
413+
1. Under "Artifacts", download the `npm-packages` artifact and extract it to a folder.
414+
1. In your repository run:
415+
416+
```console
417+
npm i <path_to_download>npm-packages/rescript-*.tgz
418+
```
419+
420+
1. Then attempt to rebuild your project as you would normally.
421+
406422
## Contribution Licensing
407423

408424
Since ReScript is distributed under the terms of the [LGPL Version 3](LICENSE), contributions that you make are licensed under the same terms. In order for us to be able to accept your contributions, we will need explicit confirmation from you that you are able and willing to provide them under these terms, and the mechanism we use to do this is called a Developer's Certificate of Origin [DCO](DCO.md). This is very similar to the process used by the Linux(R) kernel, Samba, and many other major open source projects.

0 commit comments

Comments
 (0)