Skip to content

Commit 8912b70

Browse files
committed
Add contribution guidelines.
1 parent 05ff893 commit 8912b70

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contribution Guidelines
2+
3+
Ensure your pull request adheres to the following guidelines:
4+
5+
- Search previous suggestions before making a new one, as yours may be a duplicate.
6+
- Make an individual pull request for each suggestion.
7+
- Use [title-casing](http://titlecapitalization.com) (AP style).
8+
- Use the following format: `[Title Case Name](link) - Description.`
9+
> :information_source: [Articles](https://github.com/drmacsika/fastapi-django-combo) should use the `[Title Case Name](link)` format.
10+
- Keep descriptions short and simple, but descriptive.
11+
- Start the description with a capital and end with a full stop/period.
12+
> :information_source: You can use an emoji, only before the Title-Cased Description.
13+
- Check your spelling and grammar.
14+
- Make sure your text editor is set to remove trailing whitespace.
15+
- New categories or improvements to the existing categorization are welcome.
16+
- Pull requests should have a useful title.
17+
- The body of your commit message should contain a link to the repository.
18+
19+
Thank you for your suggestion!
20+
21+
### Updating your PR
22+
23+
A lot of times, making a PR adhere to the standards above can be difficult. If the maintainers notice anything that we'd like changed, we'll ask you to edit your PR before we merge it. There's no need to open a new PR, just edit the existing one. If you're not sure how to do that, make a research on the different ways you can update your PR so that we can merge it.

0 commit comments

Comments
 (0)