1
- # Contributing <!-- omit in toc -->
1
+ # Contributing
2
2
3
3
First off, thanks for taking the time to contribute! ❤️
4
4
5
- All types of contributions are encouraged and valued, whether you want to
6
- suggest enhancements, report issues, or submit pull requests. See the
7
- [ Table of Contents] ( #table-of-contents- ) for different ways to help and details
8
- about how this project handles them. Please make sure to read the relevant
9
- section before making your contribution. It will make it a lot easier for the
10
- maintainers and smooth out the experience for all involved. The community looks
11
- forward to your contributions. 🎉
12
-
13
- > And if you like the project, but just don't have time to contribute, that's
14
- > fine. There are other easy ways to support the project and show your
15
- > appreciation which are awesome too!
16
- >
17
- > - Star it
18
- > - Post about it
19
- > - Mention it to friends and colleagues
20
-
21
- ## Table of Contents <!-- omit in toc -->
22
-
23
- - [ I Have a Question] ( #i-have-a-question )
24
- - [ I Want To Contribute] ( #i-want-to-contribute )
25
- - [ Reporting Bugs] ( #reporting-bugs )
26
- - [ Suggesting Enhancements] ( #suggesting-enhancements )
27
- - [ Your First Code Contribution] ( #your-first-code-contribution )
28
- - [ Styleguides] ( #styleguides )
29
- - [ Commit Messages] ( #commit-messages )
30
-
31
- ## I Have a Question
32
-
33
- Before you ask a question, it is best to search for existing
34
- [ issues] ( https://github.com/lewxdev/vscode-glyph/issues ) that might help you. In
35
- case you have found a suitable issue and still need clarification, you can write
36
- your question in this issue. It is also advisable to search the internet for
37
- answers first.
38
-
39
- If you then still feel the need to ask a question and need clarification, open a
40
- [ new issue] ( https://github.com/lewxdev/vscode-glyph/issues/new ) and provide as
41
- much context as you can about what you're running into.
42
-
43
- ## I Want To Contribute
44
-
45
- > ** Legal Notice**
46
- >
47
- > When contributing to this project, you must agree that you have authored 100%
48
- > of the content, that you have the necessary rights to the content and that the
49
- > content you contribute may be provided under the project license.
50
-
51
- ### Reporting Bugs
52
-
53
- #### Before Submitting a Bug Report <!-- omit in toc -->
54
-
55
- A good bug report shouldn't leave others needing to chase you down for more
56
- information. Therefore, investigate carefully, collect information and describe
57
- the issue in detail in your report. Please complete the following steps in
58
- advance to help us fix any potential bug as fast as possible.
59
-
60
- - Make sure that you are using the latest version.
61
- - Determine if your bug is really a bug and not an error on your side e.g. using
62
- incompatible environment versions (If you are looking for support, you might
63
- want to check [ this section] ( #i-have-a-question ) ).
64
- - To see if other users have experienced (and potentially already solved) the
65
- same issue you are having, check if there is not already a bug report existing
66
- for your bug or error in the
67
- [ bug tracker] ( https://github.com/lewxdev/vscode-glyph/issues?q=label%3Abug ) .
68
- - Also make sure to search the internet (including Stack Overflow) to see if
69
- users outside of the GitHub community have discussed the issue.
70
- - Collect information about the bug:
71
- - Stack trace
72
- - OS, platform and version
73
- - Version of the project
74
- - Possibly your input and the output
75
- - Can you reliably reproduce the issue? And can you also reproduce it with
76
- older versions?
77
-
78
- #### How Do I Submit a Good Bug Report? <!-- omit in toc -->
79
-
80
- > You must never report security related issues, vulnerabilities or bugs
81
- > including sensitive information to the issue tracker, or elsewhere in public.
82
- > Instead sensitive bugs must be sent by email to
83
- > [ privacy@lewx.dev ] ( mailto:privacy@lewx.dev ) .
84
-
85
- Bugs are tracked as
86
- [ GitHub issues] ( https://github.com/lewxdev/vscode-glyph/issues ) .
87
-
88
- - Open a
89
- [ new issue] ( https://github.com/lewxdev/vscode-glyph/issues/new?title=fix%3A%20%5BCHANGEME%5D&labels=bug ) .
90
- - Explain the behavior you would expect and the actual behavior.
91
- - Provide as much context as possible and describe the
92
- _ reproduction steps_ that someone else can follow to recreate the issue on
93
- their own. This usually includes your code. For good bug reports you should
94
- isolate the problem and create a reduced test case.
95
- - Provide the information you collected in the previous section.
96
-
97
- Once it's filed:
98
-
99
- - A maintainer will try to reproduce the issue with your provided steps. If
100
- there are no reproduction steps or no obvious way to reproduce the issue, the
101
- the issue will be marked as ` needs-repro ` and you will be asked for those
102
- steps. Bugs with the ` needs-repro ` tag will not be addressed until they are
103
- reproduced.
104
- - If your issue is reproducible, it will be marked ` needs-fix ` , and the issue
105
- will be left to be [ implemented by someone] ( #your-first-code-contribution ) .
106
-
107
- ### Suggesting Enhancements
108
-
109
- This section guides you through submitting an enhancement,
110
- ** including new features and minor improvements to existing functionality** .
111
- Following these guidelines will help maintainers and the community to understand
112
- your suggestion and find related suggestions.
113
-
114
- #### Before Submitting an Enhancement <!-- omit in toc -->
115
-
116
- - Make sure that you are using the latest version.
117
- - Perform
118
- [ a search] ( https://github.com/lewxdev/vscode-glyph/issues?q=label%3Aenhancement )
119
- to see if the enhancement has already been suggested. If it has, add a comment
120
- to the existing issue instead of opening a new one.
121
- - Find out whether your idea fits with the scope and aims of the project. It's
122
- up to you to make a strong case of the merits of this feature. Keep in mind
123
- that features should be useful to the _ majority_ of our users and not just a
124
- small subset. If you're just targeting a minority of users, consider building
125
- your own solution :wink : .
126
-
127
- #### How Do I Submit a Good Enhancement Suggestion? <!-- omit in toc -->
128
-
129
- Enhancement are tracked as
130
- [ GitHub issues] ( https://github.com/lewxdev/vscode-glyph/issues ) .
131
-
132
- - Open a
133
- [ new issue] ( https://github.com/lewxdev/vscode-glyph/issues/new?title=feat%3A%20%5BCHANGEME%5D&labels=enhancement ) .
134
- - Use a ** clear and descriptive issue title** that's easily identifiable.
135
- - Provide a ** step-by-step description of the suggested enhancement** in as many
136
- details as possible.
137
- - ** Describe the current behavior** and
138
- ** explain which behavior you expected to see instead** and why. At this point
139
- you can also tell which alternatives do not work for you.
140
- - You may want to ** include screenshots and animated GIFs** which help you
141
- demonstrate the steps or point out the part which the suggestion is related
142
- to. (You can use a tool like [ LICEcap] ( https://www.cockos.com/licecap/ ) on
143
- macOS and Windows and [ Silentcast] ( https://github.com/colinkeenan/silentcast )
144
- on Linux)
145
- - ** Explain why this enhancement would be useful** to most users. You may also
146
- want to point out the other projects that solved it better and which could
147
- serve as inspiration.
148
-
149
- ### Your First Code Contribution
5
+ Please see the common guidelines in the
6
+ [ CONTRIBUTING.md] ( https://github.com/lewxdev/.github/blob/main/CONTRIBUTING.md )
7
+ for more information on making your first contribution.
150
8
151
9
To contribute code changes, please follow these steps:
152
10
@@ -166,16 +24,3 @@ file and submit your changes:
166
24
style and placement.
167
25
1 . Download all exports to the ` theme/icons ` directory.
168
26
1 . Follow the steps mentioned above to submit a pull request with your changes.
169
-
170
- ## Styleguides
171
-
172
- ### Commit Messages
173
-
174
- This project uses the [ Conventional Commits] ( https://www.conventionalcommits.org/ )
175
- specification for commit messages. This convention makes it easier to understand
176
- the history of the project and to automate the release process.
177
-
178
- ## Attribution
179
-
180
- This guide is based on ** contributing-gen** .
181
- [ Make your own] ( https://generator.contributing.md ) !
0 commit comments