-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
51 additions
and
99 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Contributing | ||
|
||
Paq is small because my own needs as a Nvim user are pretty simple, | ||
but that doesn't mean I'm against adding features. If you have suggestions, | ||
write an issue! Try to be specific. When writing the titles, make the intent clear; | ||
and for the body of the issue, the more detailed the description the better. | ||
|
||
For bugs, write the title as an statement: | ||
`Paq isn't doing foo` or `Paq does bar instead of foo`. | ||
In the body, be sure to include the steps necessary to reproduce the issue, | ||
and a minimal working example. | ||
|
||
For feature requests, write the title as an imperative: | ||
`Do foo instead of bar` or `Add foo`. | ||
This makes it easier to match them to their (possible) corresponding PR. | ||
In the body, try to nail down the scope of the feature, what it should do | ||
and what it shouldn't do. Also include if you're interested in adding the | ||
feature yourself. | ||
|
||
For questions, there are no restrictions. Ask away. Just write the title a | ||
question: `Can Paq do foo?` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters