-
Notifications
You must be signed in to change notification settings - Fork 0
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
1 changed file
with
37 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,37 @@ | ||
# Contributing to _ygoprodeck-openapi_ | ||
|
||
First, thank you for considering contributing to _ygoprodeck-openapi_ description. | ||
Together, we can improve the documentation of this public API to use it on downstream projects. | ||
|
||
#### Table Of Contents | ||
* [Code of conduct](#code-of-conduct) | ||
* [How to contribute](#how-to-contribute) | ||
* [Recognition model](#recognition-model) | ||
|
||
--- | ||
|
||
## Code of conduct | ||
|
||
This project and everyone participating in it is governed by the [_ygoprodeck-openapi_ Code of Conduct][code_of_conduct]. | ||
By participating, you are expected to uphold this code. | ||
Please report unacceptable behavior to [the Issue Tracker][issue_tracker]. | ||
|
||
## How to contribute | ||
|
||
All contributions to _ygoprodeck-openapi- are welcome, either from users or developers. | ||
Contributions can be made in the form of [Issue Reports][issue_tracker] (for bug reports or feature requests) | ||
or [Pull Requests][pull_requests] (for code contributions). | ||
|
||
### Code contributions | ||
|
||
You should [make a fork](https://help.github.com/articles/fork-a-repo/) and [submit a Pull Request](https://help.github.com/articles/about-pull-requests/) to contribute. | ||
|
||
## Recognition model | ||
|
||
If you contribute to _ygoprodeck-openapi_ significantly (e.g., with a Pull Request), we would add your name to a `CONTRIBUTORS.md` file with details about your contribution(s). | ||
|
||
Currently we do not have any major contributor to the project. Be the first! | ||
|
||
[code_of_conduct]: https://github.com/magicDGS-gaming/ygoprodeck-openapi/blob/master/CODE_OF_CONDUCT.md | ||
[issue_tracker]: https://github.com/magicDGS-gaming/ygoprodeck-openapi/issues | ||
[pull_requests]: https://github.com/magicDGS-gaming/ygoprodeck-openapi/pulls |