Skip to content

Commit 1a40db4

Browse files
committed
📝 CONTRIBUTING: Add contributions guidelines
Copied them over from Knigge.
1 parent 1c911cd commit 1a40db4

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

CONTRIBUTING.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Contributing
2+
3+
If you discover issues, have ideas for improvements or new features,
4+
please [open an issue](https://github.com/sascha-wolf/ex_union/issues)
5+
or submit a pull request.
6+
7+
Make sure to follow the following guidelines when doing so.
8+
9+
## Issue Reporting
10+
11+
* Check that the issue has not already been reported.
12+
* Check that the issue has not already been fixed in the latest changes
13+
(a.k.a. `main`).
14+
* Be clear, concise and precise in your description of the problem.
15+
* Open an issue with a descriptive title and a summary in grammatically correct,
16+
complete sentences.
17+
18+
## Pull Requests
19+
20+
* Read [how to properly contribute to open source projects on GitHub](https://www.gun.io/blog/how-to-github-fork-branch-and-pull-request).
21+
* Fork the project.
22+
* Use a topic/feature branch so you're able to make additional changes later, if necessary.
23+
* Write [good commit messages](https://chris.beams.io/posts/git-commit/).
24+
* Use the same coding conventions as the rest of the project.
25+
* Commit and push until you are happy with your contribution.
26+
* Make sure to add tests for it. So we can avoid that it breaks accidentially in the future.
27+
* Add an entry to the [Changelog](./CHANGELOG.md) accordingly. See [changelog entry format](#changelog-entry-format).
28+
* Open a [pull request](https://help.github.com/articles/about-pull-requests) that relates to *only* one subject with a clear title
29+
and description in grammatically correct, complete sentences.
30+
31+
### Changelog Entry Format
32+
33+
Here are a few examples:
34+
35+
```
36+
- [#19](https://github.com/sascha-wolf/ex_union/pull/42): Fix the annoying thing ([@AmazingGitHubUser])
37+
- [#16](https://github.com/sascha-wolf/ex_union/pull/1337): Add caching to GitHub Actions ([@sascha-wolf])
38+
```
39+
40+
* Mark it up in [Markdown syntax](https://daringfireball.net/projects/markdown/syntax).
41+
* The entry line should start with `- ` (a dash and a space).
42+
* Begin with a link to your pull request (`[#456](https://github.com/sascha-wolf/ex_union/pull/456): `)
43+
* Describe the core idea of the change.
44+
* If this is a breaking change, mark it with `**(Breaking)**`.
45+
* At the end of the entry, add an implicit link to your GitHub user page as `([@username])`.
46+
* If this is your first contribution to ExUnion, add a link definition for the implicit link to the bottom of the changelog as `[@username]: https://github.com/username`.
47+
48+
*These guidelines were inspired by the [contribution guidelines of the rubocop project](https://github.com/rubocop/rubocop/blob/master/CONTRIBUTING.md).*

0 commit comments

Comments
 (0)