From b2cf7b8e22601460b035201b4fb494d43f6fa932 Mon Sep 17 00:00:00 2001 From: Felix Nicolae Bucsa Date: Thu, 6 Jun 2024 11:16:10 +0100 Subject: [PATCH 01/13] feat: Add files in gh repo and edits to templates for issues and feature requests --- .github/CODEOWNERS | 1 + .github/ISSUE_TEMPLATE/bug-report.yml | 53 +++++-- .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature-request.yml | 23 +-- .github/PULL_REQUEST_TEMPLATE/release.md | 20 +++ .github/pull_request_template.md | 34 +++++ CODE_OF_CONDUCT.md | 117 ++++------------ CONTRIBUTING.md | 156 +++++++++++++++++++++ SECURITY.md | 26 ++-- 9 files changed, 302 insertions(+), 129 deletions(-) create mode 100644 .github/CODEOWNERS create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE/release.md create mode 100644 .github/pull_request_template.md create mode 100644 CONTRIBUTING.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 000000000..d1e615987 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @MissingNO57 @pbukva \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 8f3d116b7..aa818244b 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -19,40 +19,67 @@ body: required: true - label: I checked the [existing issues](https://github.com/fetchai/fetchd/issues) to make sure my problem has not already been reported. 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) + - 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: Fetchd Version + description: Which version of fetchd were you using? Please enter the version number here. + placeholder: ex. v0.1.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, Python 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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..3ba13e0ce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index b69504ee5..4b452beb4 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -6,31 +6,22 @@ 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 to ensure we have all the details to get things 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/guides/fetch-network/ledger/cli/intro) 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. - required: true - - type: textarea - id: problem - attributes: - label: Problem - 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 + id: feature attributes: - label: Feature / Solution + label: Feature description: | - Provide a description of what you want to happen + Provide a description of the feature you would like to see implemented within fetchd. validations: required: true - type: textarea @@ -38,12 +29,12 @@ body: attributes: label: Alternatives description: | - Provide any alternative solutions or features you've considered + Provide any alternative solutions or features you've considered. - type: textarea id: info attributes: label: Additional Context description: | - Any other context or screenshots about the feature request + Any other context or screenshots about the feature request. validations: required: false diff --git a/.github/PULL_REQUEST_TEMPLATE/release.md b/.github/PULL_REQUEST_TEMPLATE/release.md new file mode 100644 index 000000000..b5918b9cf --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/release.md @@ -0,0 +1,20 @@ +## 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 +- [ ] Checks and tests pass locally +- [ ] I have regenerated and updated the API docs +- [ ] The documentation is up-to-date + +## Further Comments + +_[any other comments about this release]_ \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..4c5522202 --- /dev/null +++ b/.github/pull_request_template.md @@ -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 + +### 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...]_ diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 93e5b5515..7012adc61 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -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 sexualised 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 , version 2.1, available at . -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: . Translations are available at . diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..2142324ac --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,156 @@ +# Contribution Guidelines + +Contributions to the μAgents library are welcome. As a contributor, here are the guidelines we would like you to follow: + +- [Code of Conduct](#coc) +- [Question or Problem?](#question) +- [Issues and Bugs](#issue) +- [Feature Requests](#feature) +- [Submission Guidelines](#submit) +- [Coding Rules](#rules) +- [Commit Message Guidelines](#commit) +- [Merge Pull Requests](#merge) + +## Code of Conduct + + +Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md). + + +## Question or Problem? + + +Please use [GitHub Discussions](https://github.com/fetchai/uAgents/discussions) for support related questions and general discussions. Do NOT open issues as they are for bug reports and feature requests. This is because: + + +- Questions and answers stay available for public viewing so your question/answer might help someone else. +- GitHub Discussions voting system ensures the best answers are prominently visible. + +## Found a Bug? + +If you find a bug in the source code [submit a bug report issue](#submit-issue). +Even better, you can [submit a Pull Request](#submit-pr) with a fix. + +## Missing a Feature? + +You can *request* a new feature by [submitting a feature request issue](#submit-issue). +If you would like to *implement* a new feature: + +- For a **Major Feature**, first [open an issue](#submit-issue) and outline your proposal so that it can be discussed. +- **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr). + +## Submission Guidelines + +### Submitting an Issue + + +Before you submit an issue, please search the [issue tracker](https://github.com/fetchai/uAgents/issues). An issue for your problem might already exist and the discussion might inform you of workarounds readily available. + +For bug reports, it is important that we can reproduce and confirm it. For this, we need you to provide a minimal reproduction instruction (this is part of the bug report issue template). + +You can file new issues by selecting from our [new issue templates](https://github.com/fetchai/uAgents/issues/new/choose) and filling out the issue template. + + +### Submitting a Pull Request (PR) + +Before you submit your Pull Request (PR) consider the following guidelines: + +1. All Pull Requests should be based off of and opened against the `main` branch. + + +2. Search [Existing PRs](https://github.com/fetchai/uAgents/pulls) for an open or closed PR that relates to your submission. + You don't want to duplicate existing efforts. + + +3. Be sure that an issue exists describing the problem you're fixing, or the design for the feature you'd like to add. + + +4. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the [repository](https://github.com/fetchai/uAgents). + + +5. In your forked repository, make your changes in a new git branch created off of the `main` branch. + +6. Make your changes, **including test cases and documentation updates where appropriate**. + +7. Follow our [coding rules](#rules). + + +8. Run all tests and checks locally, and ensure they pass. This saves CI hours and ensures you only commit clean code. + + +9. Commit your changes using a descriptive commit message that follows our [commit message conventions](#commit). + +10. Push your branch to GitHub. + +11. In GitHub, send a pull request to `fetchai:main`. + +#### Reviewing a Pull Request + + +The μAgents team reserves the right not to accept pull requests from community members who haven't been good citizens of the community. Such behavior includes not following our [code of conduct](CODE_OF_CONDUCT.md) and applies within or outside the managed channels. + + +When you contribute a new feature, the maintenance burden is transferred to the core team. This means that the benefit of the contribution must be compared against the cost of maintaining the feature. + +#### Addressing review feedback + +If we ask for changes via code reviews then: + +1. Make the required updates to the code. + +2. Re-run the tests and checks to ensure they are still passing. + +3. Create a new commit and push to your GitHub repository (this will update your Pull Request). + +#### After your pull request is merged + +After your pull request is merged, you can safely delete your branch and pull the changes from the (upstream) repository. + +## Coding Rules + +To ensure consistency throughout the source code, keep these rules in mind as you are working: + + +- All code must pass our code quality checks (linters, formatters, etc). + + +- All features **must be tested** via unit-tests and if applicable integration-tests. Bug fixes also require tests, because the presence of bugs usually indicates insufficient test coverage. Tests help to: + + 1. Prove that your code works correctly, and + 2. Guard against future breaking changes and lower the maintenance cost. + +- All public features **must be documented**. +- All files must include a license header. +- Keep API compatibility in mind when you change any code under `fetchd`. + +## Commit Message Convention + +This project uses Conventional Commits to generate release notes and to determine versioning. Please follow the [Conventional Commits v1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). The commit types must be one of the following: + + - **chore**: Commits that don't directly add features, fix bugs, or refactor code, but rather maintain the project or its surrounding processes. + - **ci**: Changes to our CI configuration files and scripts. + - **docs**: Changes to the documentation. + - **feat**: A new feature. + - **fix**: A bug fix. + - **refactor**: A code change that neither fixes a bug nor adds a feature + - **test**: Adding missing tests or correcting existing tests. + - **revert**: Reverts a previous commit that introduced an issue or unintended change. This essentially undoes a previous commit. + - **style**: Changes that only affect code formatting or style, without affecting functionality. This ensures consistency and readability of the codebase. + - **perf**: Changes that improve the performance of the project. + +Commit messages should adhere to this standard and be of the form: + + ```bash + git commit -m "feat: add new feature x" + git commit -m "fix: fix bug in feature x" + git commit -m "docs: add documentation for feature x" + git commit -m "test: add test suite for feature x" + ``` + +Further details on `conventional commits` can be found [here](https://www.conventionalcommits.org/en/v1.0.0/). + +## Merging Pull Requests + +When merging a branch, PRs should be squashed into one conventional commit by selecting the `Squash and merge` option. This ensures Release notes are useful and readable when releases are created. + +See [Merge strategies](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-commits) from the official GitHub documentation. diff --git a/SECURITY.md b/SECURITY.md index 205758488..ad2f38d66 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,16 +1,22 @@ # Security Policy -Security is very important for Fetch.ai and its community. This document outlines security procedures and general policies for the `fetchd` project. +Security is very important for Fetch.ai and its community. This document outlines security procedures and general policies for the `uAgents` library. -## Reporting a Vulnerability +## How to Report -The `fetchd` team and community take all security bugs in `fetchd` seriously. We appreciate your efforts and responsible disclosure and will make every effort to acknowledge your contributions. +Please follow the steps listed below to report your bug: -Report security bugs by emailing `developer@fetch.ai`. +- In an email, describe the issue clearly with reference to the underlying source code and indicate whether the bug is **Critical** or **Non-critical**. +- Attach all relevant information that is required to reproduce the bug in a test environment. +- Include the relevant version information associated with the faulty software of the components along with any other relevant system information such as OS versions. +- Include suggested solutions and/or mitigations (if known). +- Send this email to [security@fetch.ai](mailto:security@fetch.ai) and start the subject with your classification **Critical** or **Non-critical** followed by a short title of the bug. -The lead maintainer will acknowledge your email within 48 hours, and will send a more detailed response within 48 hours indicating the next steps in handling your report. After the initial reply to your report, the security team will endeavour to keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance. +The Fetch team will review your information and your classification of the bug. -Report security bugs in third-party modules to the person or team maintaining the module. +For non-critical bugs, the Fetch team will create an issue or a pull request allowing you to follow the progress on the bug fix. + +For critical bugs that can result in loss of funds, it is important that the Fetch team has an opportunity to deploy a patched version before the exploit is acknowledged publicly. Hence, critical bugs and their fixes will be shared after the code is patched to prevent the targeting of such exploits. ## Disclosure Policy @@ -24,12 +30,6 @@ When the security team receives a security bug report, they will assign it to a If you have suggestions on how this process could be improved please submit a pull request. -## Bug Bounty - -We have a [**bug bounty program**](https://docs.fetch.ai/bug_bounty/). Please report any security issues you find, or reach out to `developer@fetch.ai`. Please try to be as explicit as possible, describing all the steps and example code to reproduce the security issue. - -Critical bug fixes will be backported to past major releases. - ## Public Discussions Please restrain from publicly discussing a potential security vulnerability. 🙊 @@ -39,5 +39,3 @@ It's better to discuss privately and try to find a solution first, to limit the --- Thanks for your help! - -The Fetch.ai community thank you for that. 🙇 From d36f2e0964aceefe44731ac65f364d7b392fdc88 Mon Sep 17 00:00:00 2001 From: Felix Nicolae Bucsa Date: Mon, 10 Jun 2024 11:48:12 +0100 Subject: [PATCH 02/13] edits: changes --- .github/pull_request_template.md | 2 +- CONTRIBUTING.md | 53 ++++++++++++++++++++++++++------ docs/CONTRIBUTING.md | 31 ------------------- 3 files changed, 45 insertions(+), 41 deletions(-) delete mode 100644 docs/CONTRIBUTING.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 4c5522202..49ef4d6d4 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -20,7 +20,7 @@ _What type of change does this pull request make (put an `x` in the boxes that a _Put an `x` in the boxes that apply:_ - - [ ] I have read the [CONTRIBUTING](CONTRIBUTING.md) guide + - [ ] I have read the [CONTRIBUTING](/CONTRIBUTING.md) guide - [ ] Checks and tests pass locally ### If applicable diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2142324ac..a3a090a7f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,6 +6,9 @@ Contributions to the μAgents library are welcome. As a contributor, here are th - [Question or Problem?](#question) - [Issues and Bugs](#issue) - [Feature Requests](#feature) +- [Documentation Setup](#documentation) + - [Prerequisites](#prerequisites) + - [Updating the docs](#updatedocs) - [Submission Guidelines](#submit) - [Coding Rules](#rules) - [Commit Message Guidelines](#commit) @@ -14,13 +17,13 @@ Contributions to the μAgents library are welcome. As a contributor, here are th ## Code of Conduct -Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md). +Please read and follow our [Code of Conduct](/CODE_OF_CONDUCT.md). ## Question or Problem? -Please use [GitHub Discussions](https://github.com/fetchai/uAgents/discussions) for support related questions and general discussions. Do NOT open issues as they are for bug reports and feature requests. This is because: +Please use [GitHub Discussions](https://github.com/fetchai/fetchd/discussions) for support related questions and general discussions. Do NOT open issues as they are for bug reports and feature requests. This is because: - Questions and answers stay available for public viewing so your question/answer might help someone else. @@ -39,36 +42,68 @@ If you would like to *implement* a new feature: - For a **Major Feature**, first [open an issue](#submit-issue) and outline your proposal so that it can be discussed. - **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr). +## Documentation Setup + +### Prerequisites + +Make sure that you have pipenv installed on your system: + + pip3 install pipenv + +Once installed navigate to this folder in the project + + cd fetchd/docs + +Make sure all the dependencies are installed + + pipenv install -d + +## Updating the docs + +Once the dependencies are setup you must activate the environment with the following commands: + + pipenv shell + +This step should update your terminal prompt and you will be able to see that the command `mkdocs` is installed in your path: + + which mkdocs + +Finally, to start the development server run the following command: + + mkdocs serve + +This will listen for changes on the filesystem and automatically update the documentation. + ## Submission Guidelines ### Submitting an Issue -Before you submit an issue, please search the [issue tracker](https://github.com/fetchai/uAgents/issues). An issue for your problem might already exist and the discussion might inform you of workarounds readily available. +Before you submit an issue, please search the [issue tracker](https://github.com/fetchai/fetchd/issues). An issue for your problem might already exist and the discussion might inform you of workarounds readily available. For bug reports, it is important that we can reproduce and confirm it. For this, we need you to provide a minimal reproduction instruction (this is part of the bug report issue template). -You can file new issues by selecting from our [new issue templates](https://github.com/fetchai/uAgents/issues/new/choose) and filling out the issue template. +You can file new issues by selecting from our [new issue templates](https://github.com/fetchai/fetchd/issues/new/choose) and filling out the issue template. ### Submitting a Pull Request (PR) Before you submit your Pull Request (PR) consider the following guidelines: -1. All Pull Requests should be based off of and opened against the `main` branch. +1. All Pull Requests should be based off of and opened against the `master` branch. -2. Search [Existing PRs](https://github.com/fetchai/uAgents/pulls) for an open or closed PR that relates to your submission. +2. Search [Existing PRs](https://github.com/fetchai/fetchd/pulls) for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts. 3. Be sure that an issue exists describing the problem you're fixing, or the design for the feature you'd like to add. -4. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the [repository](https://github.com/fetchai/uAgents). +4. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the [repository](https://github.com/fetchai/fetchd). -5. In your forked repository, make your changes in a new git branch created off of the `main` branch. +5. In your forked repository, make your changes in a new git branch created off of the `master` branch. 6. Make your changes, **including test cases and documentation updates where appropriate**. @@ -82,7 +117,7 @@ Before you submit your Pull Request (PR) consider the following guidelines: 10. Push your branch to GitHub. -11. In GitHub, send a pull request to `fetchai:main`. +11. In GitHub, send a pull request to `fetchai:master`. #### Reviewing a Pull Request diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md deleted file mode 100644 index 8b296c25a..000000000 --- a/docs/CONTRIBUTING.md +++ /dev/null @@ -1,31 +0,0 @@ -# Documentation Setup - -## Prerequisites - -Make sure that you have pipenv installed on your system: - - pip3 install pipenv - -Once installed navigate to this folder in the project - - cd fetchd/docs - -Make sure all the dependencies are installed - - pipenv install -d - -## Updating the docs - -Once the dependencies are setup you must activate the environment with the following commands - - pipenv shell - -This step should update your terminal prompt and you will be able to see that the command `mkdocs` is installed in your path - - which mkdocs - -Finally, to start the development server run the following command - - mkdocs serve - -This will listen for changes on the filesystem and automatically update the documentation. From 272d459521c7be67ef7b1ba465975c0e7f1344a4 Mon Sep 17 00:00:00 2001 From: Felix Nicolae Bucsa Date: Tue, 18 Jun 2024 13:29:00 +0100 Subject: [PATCH 03/13] edits: changes to gh resources --- .github/ISSUE_TEMPLATE/bug-report.yml | 21 +++--- .github/ISSUE_TEMPLATE/feature-request.yml | 28 ++++---- .github/PULL_REQUEST_TEMPLATE/release.md | 3 +- .github/pull_request_template.md | 10 +-- CITATION.cff | 8 +++ CODE_OF_CONDUCT.md | 4 +- CONTRIBUTING.md | 84 +++++++--------------- 7 files changed, 62 insertions(+), 96 deletions(-) create mode 100644 CITATION.cff diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index aa818244b..00eb81d51 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,23 +1,20 @@ name: 🐛 Bug Report -description: Report a reproducible bug. -title: "Bug report: " +description: Report a bug. labels: ["bug", "unconfirmed"] 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. - 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 @@ -54,9 +51,9 @@ body: - type: input id: version attributes: - label: Fetchd Version - description: Which version of fetchd were you using? Please enter the version number here. - placeholder: ex. v0.1.0 + label: Version + description: Which version were you using? Please enter the version number here. + placeholder: ex. v0.5.0 validations: required: true - type: textarea @@ -82,4 +79,4 @@ body: description: Include any screenshots, code snippets, or other relevant details that might help us understand the bug. render: markdown validations: - required: false + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 4b452beb4..166018780 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -1,40 +1,36 @@ -name: ☝️ Feature request -description: Suggest an idea for this project -title: "Feature request: " +name: ☝️Feature request +description: Suggest an idea. labels: ["enhancement", "unconfirmed"] +assignees: + - jrriehl body: - type: markdown attributes: value: | - Thank you for suggesting a new idea. 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://fetch.ai/docs/guides/fetch-network/ledger/cli/intro) 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 required: true - - label: I checked the [existing issues](https://github.com/fetchai/fetchd/issues) to make sure this feature has not already been requested. - type: textarea id: feature attributes: label: Feature description: | - Provide a description of the feature you would like to see implemented within fetchd. + 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 \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/release.md b/.github/PULL_REQUEST_TEMPLATE/release.md index b5918b9cf..ffcbcdf67 100644 --- a/.github/PULL_REQUEST_TEMPLATE/release.md +++ b/.github/PULL_REQUEST_TEMPLATE/release.md @@ -12,9 +12,10 @@ _Put an `x` in the boxes that apply._ - [ ] I am making a pull request against the `master` branch - [ ] Checks and tests pass locally +- [ ] I have updated the version in `pyproject.toml` - [ ] I have regenerated and updated the API docs - [ ] The documentation is up-to-date ## Further Comments -_[any other comments about this release]_ \ No newline at end of file +_[any other comments about this release]_ diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 49ef4d6d4..da26e4bb3 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -20,14 +20,14 @@ _What type of change does this pull request make (put an `x` in the boxes that a _Put an `x` in the boxes that apply:_ - - [ ] I have read the [CONTRIBUTING](/CONTRIBUTING.md) guide - - [ ] Checks and tests pass locally +- [ ] I have read the [CONTRIBUTING](/CONTRIBUTING.md) guide +- [ ] Checks and tests pass locally ### 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 +- [ ] 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 diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 000000000..266b2a848 --- /dev/null +++ b/CITATION.cff @@ -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: "2022-09-28" +url: "https://github.com/fetchai/fetchd" +license: "Apache-2.0" diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 7012adc61..7b053d4f2 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -18,7 +18,7 @@ Examples of behavior that contributes to a positive environment for our communit Examples of unacceptable behavior include: -- The use of sexualised language or imagery, and sexual attention or advances of any kind +- 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 @@ -70,7 +70,7 @@ Community leaders will follow these Community Impact Guidelines in determining t ## Attribution -This Code of Conduct is adapted from , version 2.1, available at . +This Code of Conduct is adapted from the , version 2.1, available at . Community Impact Guidelines were inspired by [Mozilla’s code of conduct enforcement ladder](https://github.com/mozilla/diversity). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a3a090a7f..2e23a617d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,23 +1,20 @@ # Contribution Guidelines -Contributions to the μAgents library are welcome. As a contributor, here are the guidelines we would like you to follow: +Contributions to this repository are welcome. As a contributor, here are the guidelines we would like you to follow: - [Code of Conduct](#coc) - [Question or Problem?](#question) - [Issues and Bugs](#issue) - [Feature Requests](#feature) -- [Documentation Setup](#documentation) - - [Prerequisites](#prerequisites) - - [Updating the docs](#updatedocs) - [Submission Guidelines](#submit) - [Coding Rules](#rules) -- [Commit Message Guidelines](#commit) -- [Merge Pull Requests](#merge) +- [Commit Message Convention](#commit) +- [Merging Pull Requests](#merge) ## Code of Conduct -Please read and follow our [Code of Conduct](/CODE_OF_CONDUCT.md). +Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md). ## Question or Problem? @@ -42,38 +39,6 @@ If you would like to *implement* a new feature: - For a **Major Feature**, first [open an issue](#submit-issue) and outline your proposal so that it can be discussed. - **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr). -## Documentation Setup - -### Prerequisites - -Make sure that you have pipenv installed on your system: - - pip3 install pipenv - -Once installed navigate to this folder in the project - - cd fetchd/docs - -Make sure all the dependencies are installed - - pipenv install -d - -## Updating the docs - -Once the dependencies are setup you must activate the environment with the following commands: - - pipenv shell - -This step should update your terminal prompt and you will be able to see that the command `mkdocs` is installed in your path: - - which mkdocs - -Finally, to start the development server run the following command: - - mkdocs serve - -This will listen for changes on the filesystem and automatically update the documentation. - ## Submission Guidelines ### Submitting an Issue @@ -83,14 +48,14 @@ Before you submit an issue, please search the [issue tracker](https://github.com For bug reports, it is important that we can reproduce and confirm it. For this, we need you to provide a minimal reproduction instruction (this is part of the bug report issue template). -You can file new issues by selecting from our [new issue templates](https://github.com/fetchai/fetchd/issues/new/choose) and filling out the issue template. +You can file new issues by selecting from our [new issue templates](https://github.com/fetchai/uAgents/fetchd/new/choose) and filling out the issue template. ### Submitting a Pull Request (PR) Before you submit your Pull Request (PR) consider the following guidelines: -1. All Pull Requests should be based off of and opened against the `master` branch. +1. All Pull Requests should be based off of and opened against the `main` branch. 2. Search [Existing PRs](https://github.com/fetchai/fetchd/pulls) for an open or closed PR that relates to your submission. @@ -103,26 +68,26 @@ Before you submit your Pull Request (PR) consider the following guidelines: 4. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the [repository](https://github.com/fetchai/fetchd). -5. In your forked repository, make your changes in a new git branch created off of the `master` branch. +5. In your forked repository, make your changes in a new git branch created off of the `main` branch. 6. Make your changes, **including test cases and documentation updates where appropriate**. 7. Follow our [coding rules](#rules). -8. Run all tests and checks locally, and ensure they pass. This saves CI hours and ensures you only commit clean code. +8. Run all tests and checks locally, as described in the [development guide](DEVELOPING.md), and ensure they pass. This saves CI hours and ensures you only commit clean code. 9. Commit your changes using a descriptive commit message that follows our [commit message conventions](#commit). 10. Push your branch to GitHub. -11. In GitHub, send a pull request to `fetchai:master`. +11. In GitHub, send a pull request to `fetchai:main`. #### Reviewing a Pull Request -The μAgents team reserves the right not to accept pull requests from community members who haven't been good citizens of the community. Such behavior includes not following our [code of conduct](CODE_OF_CONDUCT.md) and applies within or outside the managed channels. +The repository maintainers reserve the right not to accept pull requests from community members who haven't been good citizens of the community. Such behavior includes not following our [code of conduct](CODE_OF_CONDUCT.md) and applies within or outside the managed channels. When you contribute a new feature, the maintenance burden is transferred to the core team. This means that the benefit of the contribution must be compared against the cost of maintaining the feature. @@ -146,32 +111,31 @@ After your pull request is merged, you can safely delete your branch and pull th To ensure consistency throughout the source code, keep these rules in mind as you are working: -- All code must pass our code quality checks (linters, formatters, etc). +- All code must pass our code quality checks (linters, formatters, etc). See the [development guide](DEVELOPING.md) section for more detail. -- All features **must be tested** via unit-tests and if applicable integration-tests. Bug fixes also require tests, because the presence of bugs usually indicates insufficient test coverage. Tests help to: +- All features **must be tested** via unit-tests and if applicable integration-tests. Bug fixes also require tests, because the presence of bugs usually indicates insufficient test coverage. Tests help to: 1. Prove that your code works correctly, and - 2. Guard against future breaking changes and lower the maintenance cost. + 2. Guard against future breaking changes and lower the maintenance cost. - All public features **must be documented**. -- All files must include a license header. -- Keep API compatibility in mind when you change any code under `fetchd`. +- Keep API compatibility in mind when you change any code. Above version `1.0.0`, breaking changes can happen across versions with different left digit. Below version `1.0.0`, they can happen across versions with different middle digit. Reviewers of your pull request will comment on any API compatibility issues. ## Commit Message Convention This project uses Conventional Commits to generate release notes and to determine versioning. Please follow the [Conventional Commits v1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). The commit types must be one of the following: - - **chore**: Commits that don't directly add features, fix bugs, or refactor code, but rather maintain the project or its surrounding processes. - - **ci**: Changes to our CI configuration files and scripts. - - **docs**: Changes to the documentation. - - **feat**: A new feature. - - **fix**: A bug fix. - - **refactor**: A code change that neither fixes a bug nor adds a feature - - **test**: Adding missing tests or correcting existing tests. - - **revert**: Reverts a previous commit that introduced an issue or unintended change. This essentially undoes a previous commit. - - **style**: Changes that only affect code formatting or style, without affecting functionality. This ensures consistency and readability of the codebase. - - **perf**: Changes that improve the performance of the project. +- **chore**: Commits that don't directly add features, fix bugs, or refactor code, but rather maintain the project or its surrounding processes. +- **ci**: Changes to our CI configuration files and scripts +- **docs**: Changes to the documentation +- **feat**: A new feature +- **fix**: A bug fix +- **refactor**: A code change that neither fixes a bug nor adds a feature +- **test**: Adding missing tests or correcting existing tests +- **revert**: Reverts a previous commit that introduced an issue or unintended change. This essentially undoes a previous commit. +- **style**: Changes that only affect code formatting or style, without affecting functionality. This ensures consistency and readability of the codebase. +- **perf**: Changes that improve the performance of the project. Commit messages should adhere to this standard and be of the form: From acf693620f82abd8fba12cb2b73acb4b113c8639 Mon Sep 17 00:00:00 2001 From: Felix Nicolae Bucsa Date: Tue, 18 Jun 2024 13:30:10 +0100 Subject: [PATCH 04/13] edits: changes to gh resources --- CITATION.cff | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CITATION.cff b/CITATION.cff index 266b2a848..3bb40794c 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -5,4 +5,4 @@ authors: - family-names: Fetch.ai date-released: "2022-09-28" url: "https://github.com/fetchai/fetchd" -license: "Apache-2.0" +license: "Apache-2.0" \ No newline at end of file From 3fb479e0300aada918974638f983d2b5a71a523c Mon Sep 17 00:00:00 2001 From: Felix Nicolae Bucsa Date: Tue, 18 Jun 2024 13:41:46 +0100 Subject: [PATCH 05/13] edits --- CONTRIBUTING.md | 6 +++--- SECURITY.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2e23a617d..5319bb681 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -55,7 +55,7 @@ You can file new issues by selecting from our [new issue templates](https://gith Before you submit your Pull Request (PR) consider the following guidelines: -1. All Pull Requests should be based off of and opened against the `main` branch. +1. All Pull Requests should be based off of and opened against the `master` branch. 2. Search [Existing PRs](https://github.com/fetchai/fetchd/pulls) for an open or closed PR that relates to your submission. @@ -68,7 +68,7 @@ Before you submit your Pull Request (PR) consider the following guidelines: 4. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the [repository](https://github.com/fetchai/fetchd). -5. In your forked repository, make your changes in a new git branch created off of the `main` branch. +5. In your forked repository, make your changes in a new git branch created off of the `master` branch. 6. Make your changes, **including test cases and documentation updates where appropriate**. @@ -82,7 +82,7 @@ Before you submit your Pull Request (PR) consider the following guidelines: 10. Push your branch to GitHub. -11. In GitHub, send a pull request to `fetchai:main`. +11. In GitHub, send a pull request to `fetchai:master`. #### Reviewing a Pull Request diff --git a/SECURITY.md b/SECURITY.md index ad2f38d66..4c272026a 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,6 +1,6 @@ # Security Policy -Security is very important for Fetch.ai and its community. This document outlines security procedures and general policies for the `uAgents` library. +Security is very important for Fetch.ai and its community. This document outlines security procedures and general policies for this repository. ## How to Report From c337de70a1656ce8e045c13ad119479ec81d4035 Mon Sep 17 00:00:00 2001 From: Felix Nicolae Bucsa Date: Wed, 19 Jun 2024 09:08:51 +0100 Subject: [PATCH 06/13] editds: added date in citation.cff --- CITATION.cff | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CITATION.cff b/CITATION.cff index 3bb40794c..d08ed8d41 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -3,6 +3,6 @@ message: "If you use fetchd in your research or project, please cite it as follo title: fetchd Library authors: - family-names: Fetch.ai -date-released: "2022-09-28" +date-released: "2019-04-03" url: "https://github.com/fetchai/fetchd" license: "Apache-2.0" \ No newline at end of file From 5167206b2303b4753f7c8ab0a4849e8a4de2fdfa Mon Sep 17 00:00:00 2001 From: S Ali Hosseini <38721653+5A11@users.noreply.github.com> Date: Wed, 26 Jun 2024 15:30:34 +0100 Subject: [PATCH 07/13] Delete .github/PULL_REQUEST_TEMPLATE/release.md --- .github/PULL_REQUEST_TEMPLATE/release.md | 21 --------------------- 1 file changed, 21 deletions(-) delete mode 100644 .github/PULL_REQUEST_TEMPLATE/release.md diff --git a/.github/PULL_REQUEST_TEMPLATE/release.md b/.github/PULL_REQUEST_TEMPLATE/release.md deleted file mode 100644 index ffcbcdf67..000000000 --- a/.github/PULL_REQUEST_TEMPLATE/release.md +++ /dev/null @@ -1,21 +0,0 @@ -## 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 -- [ ] Checks and tests pass locally -- [ ] I have updated the version in `pyproject.toml` -- [ ] I have regenerated and updated the API docs -- [ ] The documentation is up-to-date - -## Further Comments - -_[any other comments about this release]_ From 1a7eb62e910c82fbb7b764f04e05ce3530fd439d Mon Sep 17 00:00:00 2001 From: S Ali Hosseini <38721653+5A11@users.noreply.github.com> Date: Wed, 26 Jun 2024 15:31:16 +0100 Subject: [PATCH 08/13] Delete CITATION.cff --- CITATION.cff | 8 -------- 1 file changed, 8 deletions(-) delete mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff deleted file mode 100644 index d08ed8d41..000000000 --- a/CITATION.cff +++ /dev/null @@ -1,8 +0,0 @@ -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" \ No newline at end of file From f0c16e9f186fbf7337842d337691f37c8de42465 Mon Sep 17 00:00:00 2001 From: S Ali Hosseini <38721653+5A11@users.noreply.github.com> Date: Wed, 26 Jun 2024 15:34:17 +0100 Subject: [PATCH 09/13] Apply suggestions from code review --- .github/CODEOWNERS | 2 +- .github/ISSUE_TEMPLATE/bug-report.yml | 6 ++++-- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/feature-request.yml | 2 +- .github/pull_request_template.md | 2 ++ 5 files changed, 9 insertions(+), 5 deletions(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index d1e615987..4f627655c 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1 +1 @@ -* @MissingNO57 @pbukva \ No newline at end of file +* @MissingNO57 @pbukva @ Josumner diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 00eb81d51..79afc4ec7 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,11 +1,13 @@ name: 🐛 Bug Report description: Report a bug. labels: ["bug", "unconfirmed"] +assignees: + - pbukva body: - type: markdown attributes: value: | - Thanks for taking the time to report a bug! We appreciate your contribution to improving the library. + Thanks for taking the time to report a bug! We appreciate your contribution to improving this repository. - type: checkboxes id: prerequisites attributes: @@ -60,7 +62,7 @@ body: id: environment attributes: label: Environment Details (Optional) - description: Provide any relevant information about your environment, such as operating system, Python version, and any other libraries used. + description: Provide any relevant information about your environment, such as operating system, Go version, and any other libraries used. render: markdown validations: required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 3ba13e0ce..0086358db 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1 +1 @@ -blank_issues_enabled: false +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 166018780..3c42f404d 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -2,7 +2,7 @@ name: ☝️Feature request description: Suggest an idea. labels: ["enhancement", "unconfirmed"] assignees: - - jrriehl + - pbukva body: - type: markdown attributes: diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index da26e4bb3..6bd21c401 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -20,8 +20,10 @@ _What type of change does this pull request make (put an `x` in the boxes that a _Put an `x` in the boxes that apply:_ + - [ ] I have read the [CONTRIBUTING](/CONTRIBUTING.md) guide - [ ] Checks and tests pass locally + ### If applicable From 61f58d75f78f5c42a771a5c512a2907b1b066d36 Mon Sep 17 00:00:00 2001 From: S Ali Hosseini <38721653+5A11@users.noreply.github.com> Date: Wed, 26 Jun 2024 15:40:47 +0100 Subject: [PATCH 10/13] Apply suggestions from code review --- .github/CODEOWNERS | 2 +- .github/ISSUE_TEMPLATE/bug-report.yml | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 4f627655c..a39abb9ae 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1 +1 @@ -* @MissingNO57 @pbukva @ Josumner +* @MissingNO57 @pbukva @Josumner diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 79afc4ec7..0a83da766 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -25,7 +25,6 @@ body: description: Select the category that best describes the bug. options: - Bug (unexpected behavior) - - Documentation Issue (error or unclear information in docs) - Other validations: required: true From 4e36f593a8cc57ddfd42fad4eb05351f1a9c9aaa Mon Sep 17 00:00:00 2001 From: S Ali Hosseini <38721653+5A11@users.noreply.github.com> Date: Wed, 26 Jun 2024 15:43:29 +0100 Subject: [PATCH 11/13] Update .github/CODEOWNERS --- .github/CODEOWNERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index a39abb9ae..445b05fbd 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1 +1 @@ -* @MissingNO57 @pbukva @Josumner +* @MissingNO57 @pbukva @Jonathansumner From 49c2a1eb93f70b2cfa155450d5767caf9bd24d95 Mon Sep 17 00:00:00 2001 From: Felix Nicolae Bucsa Date: Thu, 27 Jun 2024 12:03:03 +0100 Subject: [PATCH 12/13] edits: reverted changes and readded contributing file in docs repo --- docs/CONTRIBUTING.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 docs/CONTRIBUTING.md diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 000000000..8b296c25a --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Documentation Setup + +## Prerequisites + +Make sure that you have pipenv installed on your system: + + pip3 install pipenv + +Once installed navigate to this folder in the project + + cd fetchd/docs + +Make sure all the dependencies are installed + + pipenv install -d + +## Updating the docs + +Once the dependencies are setup you must activate the environment with the following commands + + pipenv shell + +This step should update your terminal prompt and you will be able to see that the command `mkdocs` is installed in your path + + which mkdocs + +Finally, to start the development server run the following command + + mkdocs serve + +This will listen for changes on the filesystem and automatically update the documentation. From 47412bd3af45b5f1e62dfc2969b2a7dd60adb55f Mon Sep 17 00:00:00 2001 From: S Ali Hosseini <38721653+5A11@users.noreply.github.com> Date: Thu, 27 Jun 2024 13:10:11 +0100 Subject: [PATCH 13/13] Update .github/ISSUE_TEMPLATE/bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 0a83da766..823135db1 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -80,4 +80,4 @@ body: description: Include any screenshots, code snippets, or other relevant details that might help us understand the bug. render: markdown validations: - required: false \ No newline at end of file + required: false