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: vendor/dario.cat/mergo/CONTRIBUTING.md
+2-12Lines changed: 2 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,20 +1,17 @@
1
1
<!-- omit in toc -->
2
-
3
2
# Contributing to mergo
4
3
5
4
First off, thanks for taking the time to contribute! ❤️
6
5
7
6
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
8
7
9
8
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
10
-
>
11
9
> - Star the project
12
10
> - Tweet about it
13
11
> - Refer this project in your project's readme
14
12
> - Mention the project at local meetups and tell your friends/colleagues
15
13
16
14
<!-- omit in toc -->
17
-
18
15
## Table of Contents
19
16
20
17
-[Code of Conduct](#code-of-conduct)
@@ -30,6 +27,7 @@ This project and everyone participating in it is governed by the
30
27
By participating, you are expected to uphold this code. Please report unacceptable behavior
31
28
to <>.
32
29
30
+
33
31
## I Have a Question
34
32
35
33
> If you want to ask a question, we assume that you have read the available [Documentation](https://pkg.go.dev/github.com/imdario/mergo).
@@ -47,13 +45,11 @@ We will then take care of the issue as soon as possible.
47
45
## I Want To Contribute
48
46
49
47
> ### Legal Notice <!-- omit in toc -->
50
-
>
51
48
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
52
49
53
50
### Reporting Bugs
54
51
55
52
<!-- omit in toc -->
56
-
57
53
#### Before Submitting a Bug Report
58
54
59
55
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
@@ -70,18 +66,16 @@ A good bug report shouldn't leave others needing to chase you up for more inform
70
66
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
71
67
72
68
<!-- omit in toc -->
73
-
74
69
#### How Do I Submit a Good Bug Report?
75
70
76
71
> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to .
77
-
78
72
<!-- You may add a PGP key to allow the messages to be sent encrypted as well. -->
79
73
80
74
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
81
75
82
76
- Open an [Issue](https://github.com/imdario/mergo/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
83
77
- Explain the behavior you would expect and the actual behavior.
84
-
- Please provide as much context as possible and describe the _reproduction steps_ that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
78
+
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
85
79
- Provide the information you collected in the previous section.
86
80
87
81
Once it's filed:
@@ -95,7 +89,6 @@ Once it's filed:
95
89
This section guides you through submitting an enhancement suggestion for mergo, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
96
90
97
91
<!-- omit in toc -->
98
-
99
92
#### Before Submitting an Enhancement
100
93
101
94
- Make sure that you are using the latest version.
@@ -104,7 +97,6 @@ This section guides you through submitting an enhancement suggestion for mergo,
104
97
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
105
98
106
99
<!-- omit in toc -->
107
-
108
100
#### How Do I Submit a Good Enhancement Suggestion?
109
101
110
102
Enhancement suggestions are tracked as [GitHub issues](https://github.com/imdario/mergo/issues).
@@ -116,7 +108,5 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/imdari
116
108
-**Explain why this enhancement would be useful** to most mergo users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
117
109
118
110
<!-- omit in toc -->
119
-
120
111
## Attribution
121
-
122
112
This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?v=4&size=40){kind=avatar}
0 commit comments