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
+12-9Lines changed: 12 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,11 @@ As a community, we want to help each other, provide constructive feedback, and m
4
4
5
5
## Consumer Expectations
6
6
7
-
NUKE is a personal project that was made open-source to let the whole community benefit from it **free of charge** but also ["as is"](https://github.com/GreemDev/NUKE/blob/develop/LICENSE). Like many open-source projects, it is primarily maintained and developed by a [single person](https://github.com/matkoch). Some of the **most time-consuming tasks** around the project are:
7
+
NUKE is a personal project that was made open-source to let the whole community benefit from it **free of charge** but also ["as is"](https://github.com/gruke-build/src/blob/develop/LICENSE).
8
+
Like many open-source projects, it is primarily maintained and developed by a [single person](https://github.com/GreemDev).
9
+
This is a fork of [NUKE](https://nuke.build), originally maintained and developed by [matkoch](https://github.com/matkoch).
10
+
11
+
Some of the **most time-consuming tasks** around the project are:
8
12
9
13
- Development of the NuGet package itself (C#, .NET, MSBuild)
@@ -25,9 +29,8 @@ Therefore, **everything that benefits a larger audience is prioritized** over di
25
29
26
30
There are several minimal to zero efforts you can make to show your support for the project:
27
31
28
-
- Give the [GitHub project](https://github.com/nuke-build/nuke/stargazers) a star (and tell your team)
29
-
- Upvote, share and comment on our content (see [#mentions](https://app.slack.com/client/T9QUKHC4A/CDJD8CGQ5) on Slack)
30
-
- Talk about NUKE on social media and let others know where it can help (tag us!)
32
+
- Give the [GitHub project](https://github.com/gruke-build/src/stargazers) a star (and tell your team)
33
+
- Talk about NUKE on social media and let others know where it can help
31
34
32
35
The above points are considered somewhat of the norm in exchange for using the project free of charge.
33
36
@@ -51,16 +54,16 @@ Evaluate whether your topic is going to be a valid issue:
51
54
52
55
- Have you read and searched the [documentation](https://gruke.readthedocs.io/en/latest/introduction/)?
53
56
- Have you checked the [FAQ](https://nuke.build/faq/)?
54
-
- Is your issue more of a question? Ask on [GitHub discussions](https://github.com/GreemDev/NUKE/discussions)!
57
+
- Is your issue more of a question? Ask on [GitHub discussions](https://github.com/gruke-build/src/discussions)!
55
58
- Have you checked existing/closed issues? Is your version behind?
56
-
- Have you read the relevant [changelog notes](https://github.com/GreemDev/NUKE/blob/develop/CHANGELOG.md)?
59
+
- Have you read the relevant [changelog notes](https://github.com/gruke-build/src/blob/develop/CHANGELOG.md)?
57
60
- Have you verified it's not an external tool issue? Invoke the command manually!
58
61
- Don't file issues for tool wrappers. Send a pull request instead!
59
62
- Refrain from debating the governance or state of the project out of your own interests (see [consumer expectations](#consumer-expectations) & [sustainability contributions](#sustainability-contributions))
60
63
61
64
### When creating an issue
62
65
63
-
Choose one of the [issue templates](https://github.com/GreemDev/NUKE/issues/new/choose) and fill it out as well as possible. This includes, but is not limited to:
66
+
Choose one of the [issue templates](https://github.com/gruke-build/src/issues/new/choose) and fill it out as well as possible. This includes, but is not limited to:
64
67
65
68
- State the issue as short as possible (more likely there's time to comprehend it)
66
69
- Use [markdown](https://docs.github.com/en/get-started/writing-on-github) for code, logs, and other special text fragments
@@ -86,7 +89,7 @@ The issue will be addressed sooner or later depending on the priority, available
86
89
87
90
In your own interest of getting a pull-request merged (timely):
88
91
89
-
- Discuss non-trivial changes in an [issue](https://github.com/GreemDev/NUKE/issues/new/choose)
92
+
- Discuss non-trivial changes in an [issue](https://github.com/gruke-build/src/issues/new/choose)
90
93
- Make sure your employer allows contributions
91
94
- Branch your work off from the `develop` branch
92
95
- Get familiar with the coding conventions
@@ -105,7 +108,7 @@ In your own interest of getting a pull-request merged (timely):
105
108
-[Link the issue it relates to](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) (unless it's trivial)
106
109
- Check all the applicable boxes
107
110
108
-
For tool wrappers (e.g. [.NET CLI](https://github.com/GreemDev/NUKE/blob/develop/source/Nuke.Common/Tools/DotNet/DotNet.json)), also note the following remarks:
111
+
For tool wrappers (e.g. [.NET CLI](https://github.com/gruke-build/src/blob/develop/source/Nuke.Common/Tools/DotNet/DotNet.json)), also note the following remarks:
109
112
110
113
- Copy/paste as much as possible
111
114
- Cover at least a full command with all its arguments
0 commit comments