Skip to content

Commit

Permalink
chore: add repo health files
Browse files Browse the repository at this point in the history
  • Loading branch information
@FelixNicolaeBucsa
FelixNicolaeBucsa authored Jun 27, 2024
1 parent 929563a commit baaf818
Show file tree
Hide file tree
Showing 8 changed files with 295 additions and 147 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
View file
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @MissingNO57 @pbukva @Jonathansumner
67 changes: 46 additions & 21 deletions .github/ISSUE_TEMPLATE/bug-report.yml
View file
Original file line number Diff line number Diff line change
@@ -1,58 +1,83 @@
name: 🐛 Bug Report
description: Report a reproducible bug.
title: "Bug report: <short description>"
description: Report a bug.
labels: ["bug", "unconfirmed"]
assignees:
- pbukva
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 this repository.
- 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)
- 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: environment
attributes:
label: Environment Details (Optional)
description: Provide any relevant information about your environment, such as operating system, Go version, and any other libraries used.
render: markdown
validations:
required: false
- type: textarea
id: logs
attributes:
label: Failure Logs
description: Include any relevant log snippets or files here
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
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
39 changes: 13 additions & 26 deletions .github/ISSUE_TEMPLATE/feature-request.yml
View file
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:
- pbukva
body:
- 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
36 changes: 36 additions & 0 deletions .github/pull_request_template.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
## 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:_

<!-- markdown-link-check-disable -->
- [ ] I have read the [CONTRIBUTING](/CONTRIBUTING.md) guide
- [ ] Checks and tests pass locally
<!-- markdown-link-check-enable-->

### 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...]_
117 changes: 31 additions & 86 deletions CODE_OF_CONDUCT.md
View file
Original file line number Diff line number Diff line change
@@ -1,132 +1,77 @@
# Contributor Covenant Code of Conduct
# Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual identity
and orientation.
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:
Examples of behavior that contributes to a positive environment for our community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
*developer@fetch.ai*.
All complaints will be reviewed and investigated promptly and fairly.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at _developer@fetch.ai_. All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
All community leaders are obligated to respect the privacy and security of the reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.
**Community Impact**: A violation through a single incident or series of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.
**Consequence**: A permanent ban from any sort of public interaction within the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
This Code of Conduct is adapted from the <https://www.contributor-covenant.org>, version 2.1, available at <https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
Community Impact Guidelines were inspired by [Mozilla’s code of conduct enforcement ladder](https://github.com/mozilla/diversity).

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
at [https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
For answers to common questions about this code of conduct, see the FAQ at: <https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.
Loading

0 comments on commit baaf818

Please sign in to comment.