-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add initial contribution guide content
This includes a summary on the goals of the guide and the project. The "Getting Started" section links to the head sections this guide will cover. GH-12
- Loading branch information
1 parent
e17c2e9
commit 0a61a1e
Showing
1 changed file
with
16 additions
and
0 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,16 @@ | ||
# Contributing to IceCore Hashids | ||
Thanks for contributing to IceCore Hashids! | ||
|
||
The following is a set of guidelines for contributing to IceCore Hashids. Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved. | ||
|
||
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests. | ||
|
||
As for everything else in the project, the contributions to IceCore Hashids are governed by our [Code of Conduct](https://github.com/arcticicestudio/icecore-hashids/blob/develop/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to development@arcticicestudio.com. | ||
|
||
## Getting Started | ||
|
||
IceCore Hashids is an open source project and we love to receive contributions from the community! There are many ways to contribute, from writing- and improving documentation and tutorials, reporting bugs, submit enhancement suggestions which can be incorporated into IceCore Hashids itself by submitting a pull request. | ||
|
||
Before you continue with this contribution guideslines we highly recommend to read the awesome GitHub [Open Source Guide](https://opensource.guide) on how to [making open source contributions][gh-osguide-contribute]. | ||
|
||
The [GitHub Issues][gh-issues] tracker is the preferred channel for [bug reports](#bug-reports), [enhancement suggestions](#enhancement-suggestions) and [submitting pull requests](#pull-requests). Please keep the discussion on topic and respect the opinions of others. |