Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add files in gh repo and edits to templates for issues and feat… #366

Merged
merged 14 commits into from
Jun 27, 2024
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @MissingNO57 @pbukva
5A11 marked this conversation as resolved.
Show resolved Hide resolved
68 changes: 46 additions & 22 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -1,58 +1,82 @@
name: 🐛 Bug Report
description: Report a reproducible bug.
title: "Bug report: <short description>"
description: Report a bug.
labels: ["bug", "unconfirmed"]
5A11 marked this conversation as resolved.
Show resolved Hide resolved
body:
- type: markdown
attributes:
value: |
Thank you for reporting the issue you are facing. Please complete the following so we can have the details necessary to assist you.
Thanks for taking the time to report a bug! We appreciate your contribution to improving the library.
5A11 marked this conversation as resolved.
Show resolved Hide resolved
- type: checkboxes
id: prerequisites
attributes:
label: Prerequisites
description: Please confirm before submitting a new issue
description: Please confirm before submitting any new bug report.
options:
- label: I am running the [latest fetchd version](https://docs.fetch.ai/ledger_v2/versions/).
- label: I checked the [documentation](https://fetch.ai/docs) and found no answer to my problem
required: true
- label: I checked the [documentation](https://docs.fetch.ai/ledger_v2/cli-introduction/) and found no answer to my problem.
required: true
- label: I checked the [existing issues](https://github.com/fetchai/fetchd/issues) to make sure my problem has not already been reported.
- label: I checked the [existing issues](https://github.com/fetchai/fetchd/issues) and made sure there are no similar bug reports
required: true
- type: dropdown
id: category
attributes:
label: Category
description: Select the category that best describes the bug.
options:
- Bug (unexpected behavior)
- Documentation Issue (error or unclear information in docs)
5A11 marked this conversation as resolved.
Show resolved Hide resolved
- Other
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior
description: Describe the behavior you are expecting
description: Describe the behavior you are expecting.
validations:
required: true
required: false
- type: textarea
id: actual
attributes:
label: Current Behavior
description: Describe the current behavior
label: Observed Behavior
description: Describe the behavior you are observing.
validations:
required: true
- type: textarea
id: steps
attributes:
label: To Reproduce
description: Detailed steps for reproducing the issue
description: Provide steps to reproduce the issue.
validations:
required: false
- type: textarea
id: context
- type: input
id: version
attributes:
label: Context
description: Any relevant information about your setup (this is important in case the issue is not reproducible except for under certain conditions)
placeholder: |
Operating system [e.g. MacOS], Go version [e.g. 1.18.2], fetchd version [e.g. v0.10.4], ...
label: Version
description: Which version were you using? Please enter the version number here.
placeholder: ex. v0.5.0
validations:
required: true
- type: textarea
id: logs
id: environment
attributes:
label: Failure Logs
description: Include any relevant log snippets or files here
label: Environment Details (Optional)
description: Provide any relevant information about your environment, such as operating system, Python version, and any other libraries used.
5A11 marked this conversation as resolved.
Show resolved Hide resolved
render: markdown
validations:
required: false
- type: textarea
id: logs
attributes:
label: Failure Logs (Optional)
description: Include any relevant log snippets or files here. You can paste directly or drag and drop files into this area.
render: shell
validations:
required: false
- type: textarea
id: additional
attributes:
label: Additional Information (Optional)
description: Include any screenshots, code snippets, or other relevant details that might help us understand the bug.
render: markdown
validations:
required: false
5A11 marked this conversation as resolved.
Show resolved Hide resolved
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
5A11 marked this conversation as resolved.
Show resolved Hide resolved
39 changes: 13 additions & 26 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -1,49 +1,36 @@
name: ☝️ Feature request
description: Suggest an idea for this project
title: "Feature request: <short description>"
name: ☝️Feature request
description: Suggest an idea.
labels: ["enhancement", "unconfirmed"]
assignees:
- jrriehl
body:
5A11 marked this conversation as resolved.
Show resolved Hide resolved
- type: markdown
attributes:
value: |
Thank you for suggesting a new idea for this project. Please complete the following to ensure we have all the details to get things started.
Thank you for suggesting a new idea! Please complete the following so we have everything to get started.
- type: checkboxes
id: prerequisites
attributes:
label: Prerequisites
description: Please confirm before submitting a feature request.
options:
- label: I checked the [documentation](https://docs.fetch.ai/ledger_v2/cli-introduction/) and made sure this feature does not already exist.
- label: I checked the [documentation](https://fetch.ai/docs) and made sure this feature does not already exist
required: true
- label: I checked the [existing issues](https://github.com/fetchai/fetchd/issues) to make sure this feature has not already been requested.
- label: I checked the [existing issues](https://github.com/fetchai/fetchd/issues) to make sure this feature has not already been requested
required: true
- type: textarea
id: problem
id: feature
attributes:
label: Problem
label: Feature
description: |
If your feature request relates to a problem, provide a description here, e.g. I'm always frustrated when [...]
validations:
required: false
- type: textarea
id: solution
attributes:
label: Feature / Solution
description: |
Provide a description of what you want to happen
Provide a description of the feature you would like to see implemented.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives
description: |
Provide any alternative solutions or features you've considered
- type: textarea
id: info
attributes:
label: Additional Context
label: Additional Information (Optional)
description: |
Any other context or screenshots about the feature request
Add any other context, screenshots, or information that could be helpful for understanding your feature request.
validations:
required: false
required: false
21 changes: 21 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/release.md
5A11 marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## Version Number

_[version number (e.g. v1.0.1)]_

## Release Details

_[briefly describe the main changes with this release]_

## Checklist

_Put an `x` in the boxes that apply._

- [ ] I am making a pull request against the `master` branch
5A11 marked this conversation as resolved.
Show resolved Hide resolved
- [ ] Checks and tests pass locally
- [ ] I have updated the version in `pyproject.toml`
5A11 marked this conversation as resolved.
Show resolved Hide resolved
- [ ] I have regenerated and updated the API docs
5A11 marked this conversation as resolved.
Show resolved Hide resolved
- [ ] The documentation is up-to-date

## Further Comments

_[any other comments about this release]_
34 changes: 34 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## Proposed Changes

_[describe the changes here...]_

## Linked Issues

_[if applicable, add links to issues resolved by this PR]_

## Types of changes

_What type of change does this pull request make (put an `x` in the boxes that apply)?_

- [ ] Bug fix (non-breaking change that fixes an issue).
- [ ] New feature added (non-breaking change that adds functionality).
- [ ] Breaking change (fix or feature that would cause existing functionality to stop working as expected).
- [ ] Documentation update.
- [ ] Something else (e.g., tests, scripts, example, deployment, infrastructure).

## Checklist

_Put an `x` in the boxes that apply:_

- [ ] I have read the [CONTRIBUTING](/CONTRIBUTING.md) guide
- [ ] Checks and tests pass locally

5A11 marked this conversation as resolved.
Show resolved Hide resolved
### If applicable

- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have checked that code coverage does not decrease
- [ ] I have added/updated the documentation

## Further comments

_[if this is a relatively large or complex change, kick off a discussion by explaining why you chose the solution you did, what alternatives you considered, etc...]_
8 changes: 8 additions & 0 deletions CITATION.cff
5A11 marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
cff-version: 1.2.0
message: "If you use fetchd in your research or project, please cite it as follows:"
title: fetchd Library
authors:
- family-names: Fetch.ai
date-released: "2019-04-03"
url: "https://github.com/fetchai/fetchd"
license: "Apache-2.0"
Loading
Loading