Skip to content

Commit

Permalink
Merge branch 'master' into daniyar/abi-support
Browse files Browse the repository at this point in the history
  • Loading branch information
andy-haynes authored Jan 25, 2023
2 parents 7c7370d + fe0f34d commit cc5e8a2
Show file tree
Hide file tree
Showing 8 changed files with 301 additions and 75 deletions.
85 changes: 85 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
name: Bug Report
description: Submit a bug report to help us improve
labels: [bug, 'status: needs triage']
body:
- type: markdown
attributes:
value: |
Before filing your issue, ask yourself:
- Is this clearly a NEAR JavaScript API defect?
- Do I have basic ideas about where it goes wrong? (For example, if there are stack traces, are they pointing to one file?)
**Please don't use issues for just questions**. For support please use our other channels - the [Discord server](https://near.chat) or [GitHub discussions](https://github.com/near/near-api-js/discussions).
The quickest way to verify whether it's a NEAR JavaScript API defect is through a **reproduction**, starting with a fresh project and making changes until the bug is reproduced.
- type: checkboxes
attributes:
label: Prerequisites
description: Please check the following items before creating a issue, these are basic sanity checks to make sure that the problem isn't something too obvious.
options:
- label: I'm using the latest version of `near-api-js`.
required: true
- label: I have tried to start with a fresh project and reproduce the defect with minimal code changes.
- label: I have read the console error messages carefully (if applicable).

- type: textarea
attributes:
label: Description
description: A clear and concise description of what the bug is.
validations:
required: true

- type: input
attributes:
label: Reproducible demo
description: |
(Optional) Paste the link to an example repo.
- type: textarea
attributes:
label: Steps to reproduce
description: Write down the steps to reproduce the bug.
placeholder: |
1. Step 1...
2. Step 2...
3. Step 3...
validations:
required: true

- type: textarea
attributes:
label: Expected behavior
description: |
How did you expect your project to behave? If you’re unsure, write down what you thought would happen.
placeholder: Write what you thought would happen.
validations:
required: true

- type: textarea
attributes:
label: Actual behavior
description: |
Did something go wrong? Is something broken, or not behaving as you expected?
Describe this section in detail. Please submit complete log messages with the stack traces.
placeholder: Write what happened with any error messages.
validations:
required: true

- type: textarea
attributes:
label: Your environment
description: Include as many relevant details about the environment you experienced the bug in.
value: |
- NEAR JavaScript API version used:
- Frontend framework (if applicable):
- Relevant dependencies (if applicable):
- type: checkboxes
attributes:
label: Self-service
description: |
If you feel like you could contribute to this issue, please check the box below.
If you do check this box, please send a pull request within 7 days so we can still delegate this to someone else.
options:
- label: I'd be willing to fix this bug myself.
32 changes: 0 additions & 32 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
blank_issues_enabled: false
contact_links:
- name: 🚀 Feature request
url: https://github.com/near/near-api-js/discussions
about: Use GitHub discussions for feature requests.
- name: ❓ Simple question - Discord chat
url: https://near.chat
about: This issue tracker is not for technical support. Please use our Discord chat, and ask the community for help.
- name: ❓ Simple question - Stack Overflow
url: https://stackoverflow.com/questions/tagged/nearprotocol
about: This issue tracker is not for technical support. Please use Stack Overflow, and ask the community for help.
- name: ❓ Advanced question - GitHub Discussions
url: https://github.com/near/near-api-js/discussions
about: Use GitHub Discussions for advanced and unanswered questions only, requiring a maintainer's answer. Make sure the question wasn't already asked.
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: Feature design / RFC
description: Submit a detailed feature request with a concrete proposal, including an exhaustive API design
labels: [ feature, 'status: needs triage' ]
body:
- type: markdown
attributes:
value: |
Important things:
- This is for feature request including a real API design, not just a basic idea.
- The design does not have to be perfect, we'll discuss it if needed.
- For a more "casual" feature request, consider using GitHub Discussions instead: https://github.com/near/near-api-js/discussions/categories/ideas
- type: checkboxes
attributes:
label: Have you read the Contributing Guidelines?
options:
- label: I have read the [Contributing Guidelines on issues](https://github.com/near/near-api-js/blob/master/CONTRIBUTING.md).
required: true

- type: textarea
attributes:
label: Description
description: A clear and concise description of what the feature is.
validations:
required: true

- type: input
attributes:
label: Has this been requested on GitHub Discussions?
description: Please post the [GitHub Discussions](https://github.com/near/near-api-js/discussions/categories/ideas) link, it is helpful to see how much interest there is for this feature.

- type: textarea
attributes:
label: Motivation
description: Please outline the motivation for the proposal and why it should be implemented.
validations:
required: true

- type: textarea
attributes:
label: API design
description: |
Please describe how users will use this feature.
Please explain in an exhaustive way what are the config options and their respective effects.
> **What happens if you skip this step?** This issue may be closed without any in-depth discussion. Your feature request is just an idea for now, please use GitHub Discussions for that: https://github.com/near/near-api-js/discussions/categories/ideas
- type: checkboxes
attributes:
label: Self-service
description: |
If you feel like you could contribute to this issue, please check the box below.
If you do check this box, please send a pull request within 7 days so we can still delegate this to someone else.
Note that for feature issues, we still require you to fully fill out this form and reach consensus with the maintainers on API design before rushing to implement it, so that you don't waste your time.
options:
- label: I'd be willing to contribute and develop this feature myself.
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

30 changes: 21 additions & 9 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,24 @@
## Motivation
Describe the issue or enhancement, why it's required, and link existing issues if necessary.
<!--
Thank you for sending the PR! We appreciate you spending the time to work on these changes.
You can learn more about contributing to NEAR JavaScript API here: https://github.com/near/near-api-js/blob/master/CONTRIBUTING.md
Happy contributing!
-->

## Description
Describe the changes made in this PR. How does it solve the above?
## Pre-flight checklist

## Checklist
- [ ] Read the [contributing](https://github.com/near/near-api-js/blob/master/CONTRIBUTING.md) guidelines
- [ ] I have read the [Contributing Guidelines on pull requests](https://github.com/near/near-api-js/blob/master/CONTRIBUTING.md).
- [ ] Commit messages follow the [conventional commits](https://www.conventionalcommits.org/) spec
- [ ] Performed a self-review of the PR
- [ ] Added automated tests
- [ ] Manually tested the change
- [ ] **If this is a code change**: I have written unit tests.
- [ ] **If this is a new API or substantial change**: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

## Motivation

<!-- Help us understand your motivation by explaining why you decided to make this change. Does this fix a bug? Does it close an issue? -->

## Test Plan

<!-- Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. -->

## Related issues/PRs

<!-- If you haven't already, link to issues/PRs that are related to this change. This helps us develop the context and keep a rich repo history. If this PR is a continuation of a past PR's work, link to that PR. If the PR addresses part of the problem in a meta-issue, mention that issue. -->
Loading

0 comments on commit cc5e8a2

Please sign in to comment.