Skip to content

Commit e075b7d

Browse files
committed
Add contributing guide
1 parent 33a7be3 commit e075b7d

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

CONTRIBUTING.md

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
Contributing
2+
============
3+
4+
All kinds of contributions to Quill are greatly appreciated. For someone
5+
unfamiliar with the code base, the most efficient way to contribute is usually
6+
to submit a [feature request](#feature-requests) or [bug report](#bug-reports).
7+
8+
If you want to dive into the source code, you can submit a [patch](#patches) as
9+
well. Working on [existing issues][issues] is super helpful!
10+
11+
Feature Requests
12+
----------------
13+
14+
Do you have an idea for an awesome new feature for Quill? Please [submit a
15+
feature request][issue]. It's great to hear about new ideas.
16+
17+
If you are inclined to do so, you're welcome to [fork][fork] Quill, work on
18+
implementing the feature yourself, and submit a patch. In this case, it's
19+
*highly recommended* that you first [open an issue][issue] describing your
20+
enhancement to get early feedback on the new feature that you are implementing.
21+
This will help avoid wasted efforts and ensure that your work is incorporated
22+
into the code base.
23+
24+
Bug Reports
25+
-----------
26+
27+
Did something go wrong with Quill? Sorry about that! Bug reports are greatly
28+
appreciated!
29+
30+
When you [submit a bug report][issue], please include relevant information such
31+
as Quill version, operating system, configuration, error messages, and steps to
32+
reproduce the bug. The more details you can include, the easier it is to find
33+
and fix the bug.
34+
35+
Patches
36+
-------
37+
38+
Want to hack on Quill? Awesome!
39+
40+
If there are [open issues][issues], you're more than welcome to work on those -
41+
this is probably the best way to contribute to Quill. If you have your own
42+
ideas, that's great too! In that case, before working on substantial changes to
43+
the code base, it is *highly recommended* that you first [open an issue][issue]
44+
describing what you intend to work on.
45+
46+
**Patches are generally submitted as pull requests.** Patches are also
47+
[accepted over email][email].
48+
49+
Any changes to the code base should follow the style and coding conventions
50+
used in the rest of the project. The version history should be clean, and
51+
commit messages should be descriptive and [properly formatted][commit-messages].
52+
53+
---
54+
55+
If you have any questions about anything, feel free to [ask][email]!
56+
57+
*Thanks to Anish Athalye for allowing Quill to shamelessly steal this contributing guide from [Gavel][gavel]!*
58+
59+
[issue]: https://github.com/techx/quill/issues/new
60+
[issues]: https://github.com/techx/quill/issues
61+
[fork]: https://github.com/techx/quill/fork
62+
[email]: mailto:[email protected]
63+
[commit-messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
64+
[gavel]: https://github.com/anishathalye/gavel

0 commit comments

Comments
 (0)