Skip to content

Commit 8d47bfa

Browse files
Create CONTRIBUTING.md
1 parent a26edb3 commit 8d47bfa

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

CONTRIBUTING.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## How to contribute to WinConfigWizard
2+
3+
### Bugs & other issues
4+
5+
#### Found a bug? 🐛
6+
7+
- **Ensure the bug has not already been reported** by searching [GitHub Issues](hhttps://github.com/Sleek-Stream-Theme/Sleek-Stream/issues). If there's already an open issue, feel free to add any extra information you might have about the issue.
8+
- If you're unable to find an open issue matching the problem, [open a new one](hhttps://github.com/Sleek-Stream-Theme/Sleek-Stream/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample**, **screenshot**, or a **test case** demonstrating the expected behavior that is not occurring.
9+
- Where possible, use the bug report templates to create the issue. Avoid including descriptions like "bug", "feature", etc in the issue title as these will be handled by labels.
10+
11+
#### Have a patch that fixes an issue?
12+
13+
- Great! Open a new GitHub pull request with the patch.
14+
- Ensure the PR description clearly describes the problem and solution. Include the relevant issue number, if applicable.
15+
- **Before submitting**, check the [coding conventions](#coding-conventions) section below to learn more about coding and commit message expectations.
16+
17+
### New features & enhancements
18+
19+
#### Do you intend to add a new feature, or change an existing one?
20+
21+
- Enhancements are welcome but before implementing any features, be sure to suggest your change by opening a [new discussion](hhttps://github.com/Sleek-Stream-Theme/Sleek-Stream/discussions/new) about your idea. Enhancements are discussed to ensure they fit with the project's design intent and overall roadmap.
22+
- Before opening a discussion, [check to see](hhttps://github.com/Sleek-Stream-Theme/Sleek-Stream/discussions/categories/ideas) if a similar idea is already being discussed.
23+
- All ideas and suggestions are welcome and will be judged on their merits.
24+
- If the community supports your idea, go ahead and submit a PR with the implemented feature.
25+
26+
### Questions? 🙋‍♀️
27+
28+
- If you have a general question, these should be asked using [GitHub Discussions](hhttps://github.com/Sleek-Stream-Theme/Sleek-Stream/discussions). Feel free to open a [new discussion](hhttps://github.com/Sleek-Stream-Theme/Sleek-Stream/discussions/new) to ask your question using the "Q&A" category.
29+
- Be sure to check if your question has already been answered by searching [existing Q&A discussions](hhttps://github.com/Sleek-Stream-Theme/Sleek-Stream/discussions/categories/q-a).
30+
31+
#### Commit message guidelines
32+
33+
- Use [Gitmoji](https://gitmoji.dev) in commit messages to provide context.
34+
- Clearly describe the change with a short summary in the first 72 characters.
35+
- Place more detailed explanations in paragraphs below the summary, separated by a blank line.
36+
- Use imperative language (ie. "Fix bug", not "Fixed bug" or "Fixes bug").
37+
- Do not end the summary line with a period.
38+
- Reference any issues fixed using their GitHub issue number.

0 commit comments

Comments
 (0)