-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Contributing docs and issue/PR templates (#98)
Added a CONTRIBUTING.md page with information on how to raise issues for bug reports or feature requests and steps on how to create a PR. Added templates for: - Creating an issue for reporting bugs - Creating an issue for requesting a feature - Creating a PR The issue templates are made using github forms (https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms) and are hence written in yaml. The PR template is written in markdown as github forms are not supported for PR templates yet. Fixes #91
- Loading branch information
1 parent
d8aa0eb
commit f5b0fa5
Showing
5 changed files
with
194 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,54 @@ | ||
name: Contract Bug Report | ||
description: "Use this template to report a contract side bug." | ||
title: "BUG: CONTRACT: [BUG DESCRIPTION]" | ||
labels: [bug] | ||
body: | ||
- type: textarea | ||
attributes: | ||
label: Bug description | ||
description: Provide a clear description of the bug you encountered. | ||
placeholder: Unequipping mask items is not working. Clicking the unequip button from the inventory page on a mask item has no effect. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Repro | ||
description: List the steps needed to reproduce the bug. Be as clear and detailed as possible. | ||
placeholder: | | ||
1. Go to the inventory page | ||
2. Find a mask item that is equipped to some character | ||
3. Click the unequip button | ||
4. Observe that nothing happens | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Expected behavior | ||
description: Describe the expected behavior. | ||
placeholder: Clicking the unequip button should trigger the kepler wallet to approve my transaction and remove the item from the characters inventory. | ||
validations: | ||
required: true | ||
- type: input | ||
attributes: | ||
label: Agoric-sdk version | ||
description: What branch of the agoric-sdk are you using? | ||
validations: | ||
required: true | ||
- type: input | ||
attributes: | ||
label: Branch | ||
description: What branch of the KREAd repo were you using when you encountered the bug? | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: Screenshots/Videos | ||
description: Optionally provide a screenshot or demo of the bug. | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: Additional info | ||
description: For anything else you want to add! | ||
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,29 @@ | ||
name: Feature request | ||
description: Use this template to request a new feature. | ||
title: "[FEATURE DESCRIPTION]" | ||
labels: [enhancement] | ||
body: | ||
- type: textarea | ||
attributes: | ||
label: Description | ||
description: Provide a clear description of the feature you would like to request. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Proposed Solution | ||
description: If you have a specific solution or implementation in mind, describe it here. | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: Acceptance criteria | ||
description: Describe what should be done for this issue to be considered closed. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Additional info | ||
description: For anything else you want to add! | ||
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,60 @@ | ||
name: Bug Report | ||
description: "Use this template to report a frontend side bug." | ||
title: "BUG: FRONTEND: [BUG DESCRIPTION]" | ||
labels: [bug] | ||
body: | ||
- type: textarea | ||
attributes: | ||
label: Bug description | ||
description: Provide a clear description of the bug you encountered. | ||
placeholder: Unequipping mask items is not working. Clicking the unequip button from the inventory page on a mask item has no effect. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Repro | ||
description: List the steps needed to reproduce the bug. Be as clear and detailed as possible. | ||
placeholder: | | ||
1. Go to the inventory page | ||
2. Find a mask item that is equipped to some character | ||
3. Click the unequip button | ||
4. Observe that nothing happens | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Expected behavior | ||
description: Describe the expected behavior. | ||
placeholder: Clicking the unequip button should trigger the kepler wallet to approve my transaction and remove the item from the characters inventory. | ||
validations: | ||
required: true | ||
- type: input | ||
attributes: | ||
label: Branch | ||
description: If you ran the frontend locally, what branch are you on? | ||
validations: | ||
required: false | ||
- type: input | ||
attributes: | ||
label: Connected Network | ||
description: What network is the frontend connected to (local, emerynet, mainnet). | ||
validations: | ||
required: true | ||
- type: input | ||
attributes: | ||
label: Contract branch | ||
description: If connected to a local chain, what branch are you on when running the chain? | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: Screenshots/Videos | ||
description: Optionally provide a screenshot or demo of the bug. | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: Additional info | ||
description: For anything else you want to add! | ||
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,29 @@ | ||
## Description | ||
|
||
Provide a summary of the changes introduced by this pull request. | ||
|
||
## Related Issues | ||
|
||
Mention any related issues that are being addressed by this pull request. | ||
|
||
Fixes # (issue) | ||
|
||
## Screenshots (if applicable) | ||
|
||
Include screenshots or gifs to visually demonstrate the changes made, if applicable. | ||
|
||
## Checklist | ||
|
||
Make sure all items are checked before submitting the pull request. Remove any items that are not applicable. | ||
|
||
- [ ] I have used agoric's linter on my code (https://github.com/Agoric/agoric-sdk/discussions/8274) | ||
- [ ] I have updated the documentation to reflect the changes (if applicable). | ||
- [ ] I have added/updated unit tests to cover the changes. | ||
- [ ] All existing tests pass. | ||
- [ ] The PR title is clear and concise. | ||
- [ ] Are there changes in the /fronted folder? Make sure `cd frontend && yarn build` runs successfully.; | ||
|
||
## Additional Notes | ||
|
||
Add any additional information that may be helpful for reviewers or users testing the changes. | ||
|
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,22 @@ | ||
# Contributing | ||
|
||
Thank you for considering contributing to KREAd! We appreciate your time and effort to help improve our project. You can contribute to KREAd either by filing issues for features/bugs or by submitting a Pull Request. | ||
|
||
## Issues | ||
|
||
If you've discovered a bug in the source code, identified a mistake in the documentation, or have a suggestion for a new feature, your assistance is valuable. Feel free to [raise an issue](https://github.com/Agoric/documentation/issues/new). Before creating an issue, check the [existing issues]((https://github.com/Kryha/KREAd/issues)) to ensure that your concern hasn't already been resolved! | ||
|
||
Make sure to make use of our templates either for bugs or feature requests when filing an issue! You can find them when clicking on "New Issue". | ||
|
||
## How to submit a Pull Request | ||
|
||
1. Search our repository for open or closed | ||
[Pull Requests](https://github.com/Kryha/KREAd/pulls) | ||
that relate to your submission. You don't want to duplicate effort. | ||
2. Fork the project | ||
3. Create your feature branch (`git checkout -b feature/new_feature`) | ||
4. Implement your feature | ||
5. Run the linter for agoric (https://github.com/Agoric/agoric-sdk/discussions/8274) | ||
6. Commit your changes (`git commit -m 'Add new feature'`) | ||
7. Push to the branch (`git push origin feature/new_feature`) | ||
8. [Open a Pull Request](https://github.com/Kryha/KREAd/pulls) using our PR template and make sure you go over the checklist in the template! |