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
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,9 +8,9 @@
8
8
*[Unit tests](#unit-tests)
9
9
*[Contributing process](#contributing-process)
10
10
*[Get buyoff or find open community issues or features](#get-buyoff-or-find-open-community-issues-or-features)
11
-
*[Set up your environment](#Set-up-your-environment)
11
+
*[Set up your environment](#set-up-your-environment)
12
12
*[Prepare commits](#prepare-commits)
13
-
*[Submit pull request](#Submit-pull-request)
13
+
*[Submit pull request](#submit-pull-request)
14
14
*[Respond to feedback on pull request](#respond-to-feedback-on-pull-request)
15
15
*[Other general information](#other-general-information)
16
16
*[Acknowledgement](#acknowledgement)
@@ -22,8 +22,8 @@ By contributing to Spectre.Console, you assert that:
22
22
* The contribution is your own original work.
23
23
* You have the right to assign the copyright for the work (it is not owned by your employer, or
24
24
you have been given copyright assignment in writing).
25
-
* You [license](https://github.com/spectreconsole/spectre.console/blob/main/LICENSE) the contribution under the terms applied to the rest of the Spectre.Console project.
26
-
* You agree to follow the [code of conduct](https://github.com/spectreconsole/spectre.console/blob/main/CODE_OF_CONDUCT.md).
25
+
* You [license](https://github.com/spectreconsole/spectre.console.cli/blob/main/LICENSE) the contribution under the terms applied to the rest of the Spectre.Console project.
26
+
* You agree to follow the [code of conduct](https://github.com/spectreconsole/spectre.console.cli/blob/main/CODE_OF_CONDUCT.md).
27
27
28
28
## Definition of trivial contributions
29
29
It's hard to define what is a trivial contribution. Sometimes even a 1 character change can be considered significant.
@@ -53,19 +53,19 @@ Any new code should also have reasonable unit test coverage.
53
53
## Contributing process
54
54
### Get buyoff or find open community issues or features
55
55
56
-
* Through GitHub, or through the [GitHub discussions](https://github.com/spectreconsole/spectre.console/discussions) (preferred),
56
+
* Through GitHub, or through the [GitHub discussions](https://github.com/spectreconsole/spectre.console.cli/discussions) (preferred),
57
57
you talk about a feature you would like to see (or a bug), and why it should be in Spectre.Console.
58
58
* If approved through the GitHub discussions, ensure an accompanying GitHub issue is created with
59
59
information and a link back to the discussion.
60
60
* Once you get a nod from someone in the Spectre.Console Team, you can start on the feature.
61
61
* Alternatively, if a feature is on the issues list with the
62
-
[good first issue](https://github.com/spectreconsole/spectre.console/labels/good%20first%20issue) label,
62
+
[good first issue](https://github.com/spectreconsole/spectre.console.cli/labels/good%20first%20issue) label,
63
63
it is open for a community member (contributor) to patch. You should comment that you are signing up for it on
64
64
the issue so someone else doesn't also sign up for the work.
65
65
66
66
### Set up your environment
67
67
68
-
* You create, or update, a fork of `spectreconsole/spectre.console` under your GitHub account.
68
+
* You create, or update, a fork of `spectreconsole/spectre.console.cli` under your GitHub account.
69
69
* From there you create a branch named specific to the feature.
70
70
* In the branch you do work specific to the feature.
71
71
* Please also observe the following:
@@ -96,7 +96,7 @@ Prerequisites:
96
96
97
97
Submitting PR:
98
98
99
-
* Once you feel it is ready, submit the pull request to the `spectreconsole/spectre.console` repository against the `main` branch
99
+
* Once you feel it is ready, submit the pull request to the `spectreconsole/spectre.console.cli` repository against the `main` branch
100
100
unless specifically requested to submit it against another branch.
101
101
* In the case of a larger change that is going to require more discussion,
102
102
please submit a PR sooner. Waiting until you are ready may mean more changes than you are
@@ -129,13 +129,13 @@ the issue/open a new PR (referencing old one).
129
129
Sometimes we may need you to rebase your commit against the latest code before we can review it further.
130
130
If this happens, you can do the following:
131
131
132
-
*`git fetch upstream` (upstream remote would be `spectreconsole/spectre.console`)
132
+
*`git fetch upstream` (upstream remote would be `spectreconsole/spectre.console.cli`)
133
133
*`git checkout main`
134
134
*`git rebase upstream/main`
135
135
*`git checkout your-branch`
136
136
*`git rebase main`
137
137
* Fix any merge conflicts
138
-
*`git push origin your-branch` (origin would be your GitHub repo or `your-github-username/spectre.console` in this case).
138
+
*`git push origin your-branch` (origin would be your GitHub repo or `your-github-username/spectre.console.cli` in this case).
139
139
You may need to `git push origin your-branch --force` to get the commits pushed.
140
140
This is generally acceptable with topic branches not in the mainstream repository.
0 commit comments