-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add template files and update LICENSE
- Loading branch information
1 parent
eae8c05
commit 6781594
Showing
7 changed files
with
201 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,34 @@ | ||
name: Ask a question | ||
description: Ask a question about the current behavior | ||
title: "[QUESTION]: <title>" | ||
labels: [question] | ||
body: | ||
- type: checkboxes | ||
attributes: | ||
label: Is there an existing issue for this? | ||
description: Please search to see if someone has already asked your question. | ||
options: | ||
- label: I have searched the existing issues | ||
required: true | ||
- type: checkboxes | ||
attributes: | ||
label: Have you read the documentation? | ||
description: Please ensure that the question you are asking is not already addressed in the [documentation](https://docs.koinos.io/). | ||
options: | ||
- label: I have read the documentation | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Ask a question | ||
description: Please ask your question. | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: Anything else? | ||
description: | | ||
Links? References? Anything that will give us more context about the issue you are encountering! | ||
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. | ||
validations: | ||
required: false |
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,55 @@ | ||
name: Bug report | ||
description: File a bug report | ||
title: "[BUG]: <title>" | ||
labels: [bug] | ||
body: | ||
- type: checkboxes | ||
attributes: | ||
label: Is there an existing issue for this? | ||
description: Please search to see if an issue already exists for the bug you encountered. | ||
options: | ||
- label: I have searched the existing issues | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Current behavior | ||
description: A concise description of what you're experiencing. | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: Expected behavior | ||
description: A concise description of what you expected to happen. | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: Steps to reproduce | ||
description: Steps to reproduce the behavior. | ||
placeholder: | | ||
1. In this environment... | ||
2. With this config... | ||
3. Run '...' | ||
4. See error... | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: Environment | ||
description: | | ||
Examples: | ||
- **OS**: Ubuntu 20.04 | ||
value: | | ||
- OS: | ||
render: markdown | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: Anything else? | ||
description: | | ||
Links? References? Anything that will give us more context about the issue you are encountering! | ||
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. | ||
validations: | ||
required: false |
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 @@ | ||
blank_issues_enabled: true | ||
contact_links: | ||
- name: Koinos documentation | ||
url: https://docs.koinos.io/ | ||
about: Check out the documentation to learn about features and usage | ||
- name: Koinos website | ||
url: https://koinos.io/ | ||
about: Latest news and information can be found on the Koinos website | ||
- name: Koinos on Discord | ||
url: https://discord.com/invite/GErGNsu | ||
about: Join the conversation about Koinos on Discord | ||
- name: Koinos on Telegram | ||
url: https://t.me/joinchat/SXe6mLnb8Ssywlq9 | ||
about: Join the conversation about Koinos on Telegram | ||
- name: Koinos on Twitter | ||
url: https://twitter.com/koinosnetwork | ||
about: Learn about the latest news about Koinos on Twitter | ||
- name: Koinos on YouTube | ||
url: https://www.youtube.com/channel/UCamXqlj7q14TllcrCM0ikkw | ||
about: Watch tutorials, interviews with the developers, and more on YouTube | ||
|
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,27 @@ | ||
name: Feature request | ||
description: Propose a new feature | ||
title: "[FEATURE]: <title>" | ||
labels: [enhancement] | ||
body: | ||
- type: checkboxes | ||
attributes: | ||
label: Is there an existing issue for this? | ||
description: Please search to see if someone has already suggested this feature. | ||
options: | ||
- label: I have searched the existing issues | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: New feature | ||
description: Please describe the new feature proposal and the use case it addresses. | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: Anything else? | ||
description: | | ||
Links? References? Anything that will give us more context about the issue you are encountering! | ||
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. | ||
validations: | ||
required: false |
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,15 @@ | ||
Resolves <!-- Issue number(s) in the form #1 or org/repo#1 --> | ||
|
||
## Brief description | ||
<!-- Add a brief summary of the code changes in the pull request --> | ||
|
||
## Checklist | ||
|
||
- [ ] I have built this pull request locally | ||
- [ ] I have ran the unit tests locally | ||
- [ ] I have manually tested this pull request | ||
- [ ] I have reviewed my pull request | ||
- [ ] I have added any relevant tests | ||
|
||
## Demonstration | ||
<!-- If applicable, attach screenshot or terminal output of working code --> |
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,48 @@ | ||
# Contributing guidelines | ||
We want to make contributing to this project as easy and transparent as possible, whether it's: | ||
|
||
- Reporting a bug | ||
- Discussing the current state of the code | ||
- Submitting a fix | ||
- Proposing new features | ||
- Becoming a maintainer | ||
|
||
## We develop with Github | ||
We use github to host code, to track issues and feature requests, as well as accept pull requests. | ||
|
||
## We use [Github Flow](https://guides.github.com/introduction/flow/index.html), so all code changes happen through pull requests | ||
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests: | ||
|
||
1. Fork the repo and create your branch from `master`. | ||
2. If you've added code that should be tested, add tests. | ||
3. If you've changed APIs, update the documentation. | ||
4. Ensure the test suite passes. | ||
5. Make sure your code lints. | ||
6. Issue that pull request! | ||
|
||
## Any contributions you make will be under the MIT Software License | ||
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern. | ||
|
||
## Report bugs using Github's issues | ||
We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy! | ||
|
||
## Write bug reports with detail, background, and sample code | ||
When submitting a new issue use your best effort to choose the appropriate issue template. | ||
|
||
**Great bug reports** tend to have: | ||
|
||
- A quick summary and/or background | ||
- Steps to reproduce | ||
- Be specific! | ||
- What you expected would happen | ||
- What actually happens | ||
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) | ||
|
||
People *love* thorough bug reports. I'm not even kidding. | ||
|
||
## Use consistent code styling | ||
Before submitting a pull request ensure that your code matches the style of repository. Pay special attention to | ||
spaces, tabs, and line endings. | ||
|
||
## License | ||
By contributing, you agree that your contributions will be licensed under its MIT License. |
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