You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,13 +35,13 @@ ALSO NOTE: github.com lets you create a pull request from the main branch, autom
35
35
36
36
### Upstream Testing
37
37
38
-
`linkml-runtime` is tightly coupled to upstream `linkml`,
38
+
`linkml-runtime` is tightly coupled to upstream `linkml`,
39
39
so all pull requests have their changes tested by running the upstream tests
40
40
against the PR version of `linkml-runtime`.
41
41
42
42
In some circumstances, paired changes need to be made against *both*
43
43
`linkml` and `linkml-runtime`, where testing against the `main` branch
44
-
of `linkml` is insufficient.
44
+
of `linkml` is insufficient.
45
45
46
46
When opening a pull request, you can specify that your PR needs to be
47
47
tested against a specific upstream branch and repository by specifying it
@@ -50,15 +50,15 @@ in the first two lines of your pull request like this:
50
50
```
51
51
upstream_repo: my-cool-username/linkml
52
52
upstream_branch: some-complicated-feature
53
-
53
+
54
54
Hey everyone what up it's me your boy MC spongebob here with another banger
55
55
... (PR continues)
56
56
```
57
57
58
58
The order of the `upstream_repo` and `upstream_branch` tags doesn't matter,
59
59
but they must be on the first two lines of the pull request comment and separated with a colon.
60
60
61
-
Maintainers can also specify upstream branches to test against when
61
+
Maintainers can also specify upstream branches to test against when
62
62
dispatching the `test-upstream` workflow manually via the GUI prompt.
63
63
64
64
Testing against an unverified upstream branch is not necessarily dangerous,
@@ -92,7 +92,7 @@ Once the code has been merged into the `main` branch on this repo, there are a f
92
92
93
93
* Use the [releases](https://github.com/linkml/linkml-runtime/releases) section of the Github interface to draft a new release.
94
94
* Conventionally tags are prefixed with `v` so choose an appropriately versioned tag number. Ex., `v1.1.9` and such.
95
-
* Leave the default `main` branch as the target. Use the same tag number for the release title as well. After that, use Github's autogenerated CHANGELOG button to generate release notes. If it's possible to simplify the notes and make it more succinct, you should.
95
+
* Leave the default `main` branch as the target. Use the same tag number for the release title as well. After that, use Github's autogenerated CHANGELOG button to generate release notes. If it's possible to simplify the notes and make it more succinct, you should.
96
96
* Once a release is created, a [Github Action](.github/workflows/pypi-publish.yaml) will take care of publishing the package to PyPI for you.
97
97
98
98
* Navigate to the [Actions](https://github.com/linkml/linkml-runtime/actions) tab, and verify that there is a ✅ next to the release tag that was just created. For ex., [v1.1.15](https://github.com/linkml/linkml-runtime/actions/runs/1656285916).
0 commit comments