Skip to content

Commit f353b09

Browse files
committed
Create CONTRIBUTING.md
1 parent bf74463 commit f353b09

File tree

1 file changed

+89
-0
lines changed

1 file changed

+89
-0
lines changed

CONTRIBUTING.md

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# Contributing to drawDB
2+
3+
Thanks for taking the time to contribute!
4+
5+
The following is a set of guidelines for contributing to our project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
6+
7+
## Table of Contents
8+
9+
1. [How Can I Contribute?](#how-can-i-contribute)
10+
- [Reporting Bugs](#reporting-bugs)
11+
- [Suggesting Enhancements](#suggesting-enhancements)
12+
- [Submitting Pull Requests](#submitting-pull-requests)
13+
2. [Style Guides](#style-guides)
14+
- [Git Commit Messages](#git-commit-messages)
15+
- [Style Guide](#style-guide)
16+
3. [Additional Notes](#additional-notes)
17+
- [Issue and Pull Request Labels](#issue-and-pull-request-labels)
18+
- [Getting Help](#getting-help)
19+
20+
## How Can I Contribute?
21+
22+
### Reporting Bugs
23+
24+
This section guides you through submitting a bug report for our project. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
25+
26+
- Use a clear and descriptive title for the issue to identify the problem.
27+
- Describe the exact steps which reproduce the problem in as many details as possible.
28+
- Provide specific examples to demonstrate the steps (e.g. if you're having trouble importing a file please attach it or provide a link to it).
29+
- Include screenshots if applicable.
30+
- Explain which behavior you expected to see instead and why.
31+
32+
### Suggesting Enhancements
33+
34+
This section guides you through submitting an enhancement suggestion for our project, including completely new features and minor improvements to existing functionality.
35+
36+
- Use a clear and descriptive title for the issue to identify the suggestion.
37+
- Explain why this enhancement would be useful to most users.
38+
39+
### Submitting Pull Requests
40+
41+
If you would like to implement a big feature that has not been discussed before please reach out to the maintainer on Discord at @dottle_ or send an email to [email protected].
42+
43+
Please follow these steps to have your contribution considered by the maintainers:
44+
45+
1. Make sure the pull request you work on is atomic. That is, it implements a single feature or fixes a single bug.
46+
2. Fork the repository and create your branch from `main`.
47+
3. Write clear, descriptive commit messages.
48+
4. Ensure your code adheres to the project's style guides.
49+
5. Create a pull request.
50+
6. Make sure to explain what your pull request solves unless it fixes something already explained in an issue that it's linked to.
51+
7. Explain the solution. If you implement a more involved feature explain the design decisions.
52+
53+
## Style Guides
54+
55+
### Git Commit Messages
56+
57+
- Use the present tense (e.g. "Add Spanish locale" not "Added Spanish locale").
58+
- Use the imperative mood (e.g. "Move cursor to..." not "Moves cursor to...").
59+
- Reference issues and pull requests liberally after the first line.
60+
61+
### Style Guide
62+
63+
- Format your code with Prettier.
64+
- Ensure your code passes ESLint.
65+
- Make sure the code base is in English, this includes comments and variable names.
66+
67+
## Additional Notes
68+
69+
### Issue and Pull Request Labels
70+
71+
This section lists the labels we use to help organize and identify issues and pull requests.
72+
73+
- `bug`: Something isn't working.
74+
- `enhancement`: New feature or request.
75+
- `question`: Further information is requested.
76+
- `documentation`: Improvements or additions to documentation.
77+
- `good first issue`: Good for newcomers.
78+
- `help wanted`: Extra attention is needed.
79+
80+
### Getting Help
81+
82+
If you have any questions, please feel free to reach out to us through the following channels:
83+
84+
- [Discord](https://discord.gg/BrjZgNrmR6)
85+
86+
87+
---
88+
89+
Thank you for your contributions! ❤️

0 commit comments

Comments
 (0)