Skip to content

Commit 954fe81

Browse files
authored
📝 create CONTRIBUTING.md [ci skip]
1 parent 2b25a54 commit 954fe81

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

CONTRIBUTING.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Contributing to Autocomplete SQL
2+
Thank you for taking the time to contribute! :+1:
3+
4+
These are guidelines, not rules. Use your best judgment. Feel free to propose changes to this document in a pull request.
5+
6+
All contributors will be listed in [Contributors].
7+
8+
## Code of Conduct
9+
Please remember that all participants, are expected to uphold the [Code of Conduct]. Please report unacceptable behavior by submitting an [issue] with a <kbd>**[conduct]**</kbd> label.
10+
11+
## How to Contribute
12+
### Reporting Bugs
13+
Please read and use the [Issue Template].
14+
15+
### Suggesting Features or Enhancements
16+
Please submit an issue with a <kbd>**[suggest]**</kbd> label to suggest a feature or enhancement.
17+
18+
### Documentation
19+
Please be consise in writing documentation and use [Markdown]. Command line instructions are preferred over GUI information. Please use the <kbd>**[documentation]**</kbd> label.
20+
21+
### Git Commit Messages
22+
- Use the present tense ("Add feature" not "Added feature")
23+
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
24+
- Limit the first line to 72 characters or less
25+
- Reference issues and pull requests liberally after the first line
26+
- When only changing documentation, include `[ci skip]` in the commit description
27+
- Consider starting the commit message with an applicable emoji:
28+
- :art: `:art:` when writing code or improving it
29+
- :racehorse: `:racehorse:` when improving performance
30+
- :non-potable_water: `:non-potable_water:` when plugging memory leaks
31+
- :memo: `:memo:` when writing docs
32+
- :bug: `:bug:` when fixing a bug
33+
- :fire: `:fire:` when removing code or files
34+
- :green_heart: `:green_heart:` when fixing the CI build
35+
- :white_check_mark: `:white_check_mark:` when adding tests
36+
- :shirt: `:shirt:` when removing linter warnings
37+
38+
### Pull Requests
39+
- Please read and use the [Pull Request Template]
40+
- Do not include issue numbers in the PR title
41+
- Include screenshots and animated GIFs in your pull request whenever possible.
42+
43+
[Code of Conduct]: https://github.com/webdevel/autocomplete-sql/blob/master/CODE_OF_CONDUCT.md
44+
[Contributors]: https://github.com/webdevel/autocomplete-sql/blob/master/CONTRIBUTORS.md
45+
[conduct]: https://github.com/webdevel/autocomplete-sql/labels/conduct
46+
[documentation]: https://github.com/webdevel/autocomplete-sql/labels/documentation
47+
[suggest]: https://github.com/webdevel/autocomplete-sql/labels/suggest
48+
[issue]: https://github.com/webdevel/autocomplete-sql/issues
49+
[Issue Template]: https://github.com/webdevel/autocomplete-sql/blob/master/ISSUE_TEMPLATE.md
50+
[Pull Request Template]: https://github.com/webdevel/autocomplete-sql/blob/master/PULL_REQUEST_TEMPLATE.md
51+
[Markdown]: https://daringfireball.net/projects/markdown

0 commit comments

Comments
 (0)