From 99a8a54bd5e77bddb31ac2848a06acf7400d580e Mon Sep 17 00:00:00 2001 From: Felix Nicolae Bucsa Date: Thu, 6 Jun 2024 12:22:58 +0100 Subject: [PATCH 01/13] edits: changes to files in gh repo --- .github/ISSUE_TEMPLATE/bug-report.yml | 6 +- .github/pull_request_template.md | 35 ++++++----- CODE_OF_CONDUCT.md | 7 +-- CONTRIBUTING.md | 88 ++++++++++++++++++--------- SECURITY.md | 26 ++++---- 5 files changed, 93 insertions(+), 69 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index ac830778..1e560594 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -13,13 +13,13 @@ body: label: Prerequisites description: Please confirm before submitting a new issue options: - - label: I am running the [latest CosmPy version](https://docs.fetch.ai/CosmPy/#version). + - label: I am running the [latest CosmPy version](https://fetch.ai/docs/guides/fetch-network/cosmpy/install#version). required: true - - label: I checked the [documentation](http://docs.fetch.ai/CosmPy/) and found no answer to my problem. + - label: I checked the [documentation](https://fetch.ai/docs/guides/fetch-network/cosmpy/install) and found no answer to my problem. required: true - label: I checked the [existing issues](https://github.com/fetchai/cosmpy/issues) to make sure my problem has not already been reported. required: true - - label: I have read the [code of conduct](https://github.com/fetchai/cosmpy/blob/main/CODE_OF_CONDUCT.md) before creating this issue. + - label: I have read the [code of conduct](CODE_OF_CONDUCT.md) before creating this issue. required: true - type: textarea id: expected diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 53dacea0..49ef4d6d 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,35 +1,34 @@ -## Proposed changes +## Proposed Changes -Describe the changes here. +_[describe the changes here...]_ -## Issues +## Linked Issues -Links to any issues resolved. +_[if applicable, add links to issues resolved by this PR]_ ## Types of changes -What types of changes does your code introduce? -_Put an `x` in the boxes that apply_ +_What type of change does this pull request make (put an `x` in the boxes that apply)?_ -- [ ] Bugfix (non-breaking change that fixes an issue) -- [ ] New feature (non-breaking change that adds functionality) -- [ ] Breaking change (fix or feature that would cause existing functionality to stop working as expected) -- [ ] Something else (e.g. tests, scripts, example, deployment, infrastructure, ...) +- [ ] 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._ +_Put an `x` in the boxes that apply:_ -- [ ] I have read the [CONTRIBUTING](https://github.com/fetchai/cosmpy/blob/main/CONTRIBUTING.md) document. -- [ ] I have based my branch, and I am making a pull request against, the `main` branch. -- [ ] 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 documentations. + - [ ] 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 the discussion by explaining why you chose the solution you did, what alternatives you considered, etc. +_[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 02c407e5..7012adc6 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 sexualized language or imagery, and sexual attention or advances of any kind +- 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 @@ -70,9 +70,8 @@ Community leaders will follow these Community Impact Guidelines in determining t ## Attribution -This Code of Conduct is adapted from the , version 2.1, -available at . +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](https://github.com/mozilla/diversity). -For answers to common questions about this code of conduct, see the FAQ at . Translations are available at . +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 index 040285d1..20ec0409 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contribution Guidelines -Contributions to the CosmPy library are welcome. As a contributor, here are the guidelines we would like you to follow: +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) @@ -9,14 +9,19 @@ Contributions to the CosmPy library are welcome. As a contributor, here are the - [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][coc]. + +Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md). + ## Question or Problem? -Please use [GitHub Discussions][ghdiscussion] 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/cosmpy/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. @@ -38,24 +43,30 @@ If you would like to *implement* a new feature: ### Submitting an Issue -Before you submit an issue, please search the [issue tracker][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/cosmpy/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][new-issue] and filling out the issue template. +You can file new issues by selecting from our [new issue templates](https://github.com/fetchai/cosmpy/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. **Note that we have recently stopped using the _develop_ branch for feature consolidation.** +1. All Pull Requests should be based off of and opened against the `main` branch. -2. Search [Existing PRs][prs] for an open or closed PR that relates to your submission. + +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][github]. + +4. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the [repository](https://github.com/fetchai/cosmpy). + 5. In your forked repository, make your changes in a new git branch created off of the `main` branch. @@ -63,7 +74,9 @@ Before you submit your Pull Request (PR) consider the following guidelines: 7. Follow our [coding rules](#rules). -8. Run all tests and checks locally, as described in the [development guide][developing], 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). @@ -73,7 +86,9 @@ Before you submit your Pull Request (PR) consider the following guidelines: #### Reviewing a Pull Request -The CosmPy 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][coc] and applies within or outside the managed channels. + +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. @@ -95,7 +110,10 @@ 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). See the [development guide][developing] section for more detail. + +- 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: 1. Prove that your code works correctly, and @@ -107,22 +125,32 @@ To ensure consistency throughout the source code, keep these rules in mind as yo ## Commit Message Convention -Please follow the [Conventional Commits v1.0.0][convcommit]. The commit types must be one of the following: - -- **build**: Changes that affect the build system or external dependencies -- **ci**: Changes to our CI configuration files and scripts -- **docs**: Changes to the documentation -- **feat**: A new feature -- **fix**: A bug fix -- **nfunc**: Code that improves some non-functional characteristic, such as performance, security, ... -- **refactor**: A code change that neither fixes a bug nor adds a feature -- **test**: Adding missing tests or correcting existing tests - -[coc]: https://github.com/fetchai/cosmpy/blob/main/CODE_OF_CONDUCT.md -[developing]: https://github.com/fetchai/cosmpy/blob/main/DEVELOPING.md -[ghdiscussion]: https://github.com/fetchai/cosmpy/discussions -[issues]: https://github.com/fetchai/cosmpy/issues -[new-issue]: https://github.com/fetchai/cosmpy/issues/new/choose -[prs]: https://github.com/fetchai/cosmpy/pulls -[convcommit]: https://www.conventionalcommits.org/en/v1.0.0/ -[github]: https://github.com/fetchai/cosmpy \ No newline at end of file +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 77964df5..03837c6b 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 `cosmpy` project. +Security is very important for Fetch.ai and its community. This document outlines security procedures and general policies for the `cosmpy` library. ## Supported Versions @@ -10,15 +10,21 @@ The following table shows which versions of `cosmpy` are currently being support | --------- | ------------------ | | `< 1.0.0` | :white_check_mark: | -## Reporting a Vulnerability +## How to Report -The `cosmpy` team and community take all security bugs in `cosmpy` 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 @@ -32,12 +38,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. 🙊 @@ -47,5 +47,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. 🙇 \ No newline at end of file From b1e49d1a956601380131c3e9dfc06f2f29730c98 Mon Sep 17 00:00:00 2001 From: Felix Nicolae Bucsa Date: Tue, 18 Jun 2024 13:20:32 +0100 Subject: [PATCH 02/13] edits: updated gh resources --- .github/ISSUE_TEMPLATE/bug-report.yml | 70 ++++++++++++++-------- .github/ISSUE_TEMPLATE/feature-request.yml | 37 ++++-------- .github/PULL_REQUEST_TEMPLATE/release.md | 23 ++++--- .github/pull_request_template.md | 10 ++-- CITATION.cff | 8 +++ CODE_OF_CONDUCT.md | 6 +- CONTRIBUTING.md | 39 ++++++------ SECURITY.md | 10 +--- 8 files changed, 103 insertions(+), 100 deletions(-) create mode 100644 CITATION.cff diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 1e560594..83f26212 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,60 +1,82 @@ 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 CosmPy version](https://fetch.ai/docs/guides/fetch-network/cosmpy/install#version). + - label: I checked the [documentation](https://fetch.ai/docs) and found no answer to my problem required: true - - label: I checked the [documentation](https://fetch.ai/docs/guides/fetch-network/cosmpy/install) and found no answer to my problem. - required: true - - label: I checked the [existing issues](https://github.com/fetchai/cosmpy/issues) to make sure my problem has not already been reported. - required: true - - label: I have read the [code of conduct](CODE_OF_CONDUCT.md) before creating this issue. + - label: I checked the [existing issues](https://github.com/fetchai/cosmpy/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) + - 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, Python version, CosmPy version, ... + 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. + 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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index bd692f26..57392177 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -1,51 +1,34 @@ -name: ☝️ Feature request -description: Suggest an idea for this project -title: "Feature request: " +name: ☝️Feature request +description: Suggest an idea. labels: ["enhancement", "unconfirmed"] 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](http://docs.fetch.ai/CosmPy/) 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/cosmpy/issues) to make sure this feature has not already been requested. - required: true - - label: I have read the [code of conduct](https://github.com/fetchai/cosmpy/blob/main/CODE_OF_CONDUCT.md) before creating this issue. + - label: I checked the [existing issues](https://github.com/fetchai/cosmpy/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 diff --git a/.github/PULL_REQUEST_TEMPLATE/release.md b/.github/PULL_REQUEST_TEMPLATE/release.md index 1b6d2278..99c2a2bd 100644 --- a/.github/PULL_REQUEST_TEMPLATE/release.md +++ b/.github/PULL_REQUEST_TEMPLATE/release.md @@ -1,22 +1,21 @@ -## Release summary +## Version Number -Version number: [e.g. 1.0.1] +_[version number (e.g. v1.0.1)]_ -## Release details +## Release Details -Briefly describe the main changes with the new release. +_[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 `main` branch from `release/v...`. -- [ ] 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. -- [ ] I have added an item in `HISTORY.md` for this release. +- [ ] I am making a pull request against the `main` 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 +## Further Comments -Write here any other comment (if any) about the release. +_[any other comments about this release]_ diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 49ef4d6d..da26e4bb 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 00000000..8197ea34 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,8 @@ +cff-version: 1.2.0 +message: "If you use CosmPy in your research or project, please cite it as follows:" +title: CosmPy Library +authors: + - family-names: Fetch.ai +date-released: "2022-09-28" +url: "https://github.com/fetchai/cosmpy" +license: "Apache-2.0" \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 7012adc6..5a9559a9 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,8 +70,8 @@ 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). -For answers to common questions about this code of conduct, see the FAQ at: . Translations are available at . +For answers to common questions about this code of conduct, see the FAQ at: . Translations are available at . \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 20ec0409..123a1679 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # 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) @@ -8,8 +8,8 @@ Contributions to the μAgents library are welcome. As a contributor, here are th - [Feature Requests](#feature) - [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 @@ -58,7 +58,7 @@ 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. +2. Search [Existing PRs](https://github.com/fetchai/cosmpy/pulls) for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts. @@ -87,7 +87,7 @@ Before you submit your Pull Request (PR) consider the following guidelines: #### 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. @@ -114,29 +114,28 @@ To ensure consistency throughout the source code, keep these rules in mind as yo - 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 `cosmpy`. 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. +- 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: @@ -153,4 +152,4 @@ Further details on `conventional commits` can be found [here](https://www.conven 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. +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. \ No newline at end of file diff --git a/SECURITY.md b/SECURITY.md index 03837c6b..4c272026 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,14 +1,6 @@ # Security Policy -Security is very important for Fetch.ai and its community. This document outlines security procedures and general policies for the `cosmpy` library. - -## Supported Versions - -The following table shows which versions of `cosmpy` are currently being supported with security updates. - -| Version | Supported | -| --------- | ------------------ | -| `< 1.0.0` | :white_check_mark: | +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 5d2c9e38cb30d2b44cafacfa90a53280e2783a65 Mon Sep 17 00:00:00 2001 From: Felix Nicolae Bucsa Date: Wed, 19 Jun 2024 09:06:07 +0100 Subject: [PATCH 03/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 8197ea34..d4b95041 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -3,6 +3,6 @@ message: "If you use CosmPy in your research or project, please cite it as follo title: CosmPy Library authors: - family-names: Fetch.ai -date-released: "2022-09-28" +date-released: "2021-06-01" url: "https://github.com/fetchai/cosmpy" license: "Apache-2.0" \ No newline at end of file From 971f1250b0219990b745635d0366a7424356ca18 Mon Sep 17 00:00:00 2001 From: S Ali Hosseini <38721653+5A11@users.noreply.github.com> Date: Tue, 25 Jun 2024 10:42:19 +0100 Subject: [PATCH 04/13] Update .github/PULL_REQUEST_TEMPLATE/release.md --- .github/PULL_REQUEST_TEMPLATE/release.md | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/release.md b/.github/PULL_REQUEST_TEMPLATE/release.md index 99c2a2bd..8eb1211c 100644 --- a/.github/PULL_REQUEST_TEMPLATE/release.md +++ b/.github/PULL_REQUEST_TEMPLATE/release.md @@ -10,7 +10,6 @@ _[briefly describe the main changes with this release]_ _Put an `x` in the boxes that apply._ -- [ ] I am making a pull request against the `main` branch - [ ] Checks and tests pass locally - [ ] I have updated the version in `pyproject.toml` - [ ] I have regenerated and updated the API docs From adb18af2d33e2c402e4c637a2eb7accf03662c20 Mon Sep 17 00:00:00 2001 From: ali Date: Tue, 25 Jun 2024 10:56:37 +0100 Subject: [PATCH 05/13] fixes to manifest, dicionary, links --- .github/pull_request_template.md | 2 ++ .wordlist.txt | 2 ++ MANIFEST.in | 1 + 3 files changed, 5 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index da26e4bb..6bd21c40 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 diff --git a/.wordlist.txt b/.wordlist.txt index 90fe9184..4dee9f07 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -312,3 +312,5 @@ noqa biputils googleapis M1 +perf +mitigations diff --git a/MANIFEST.in b/MANIFEST.in index 2a7e2439..00e8034f 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -18,3 +18,4 @@ recursive-exclude examples *.py recursive-exclude scripts *.py recursive-exclude scripts *.sh recursive-exclude tests *.py +include *.cff \ No newline at end of file From 35385cd0ca8f462d1a632708c23ce0f529899d04 Mon Sep 17 00:00:00 2001 From: ali Date: Tue, 25 Jun 2024 11:04:13 +0100 Subject: [PATCH 06/13] fix: manifest --- MANIFEST.in | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/MANIFEST.in b/MANIFEST.in index 00e8034f..fa76497d 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -8,6 +8,7 @@ exclude *.txt exclude *.yml exclude strategy.ini exclude tox.ini +exclude *.cff exclude .firebaserc recursive-exclude contracts *.txt recursive-exclude contracts *.wasm @@ -18,4 +19,3 @@ recursive-exclude examples *.py recursive-exclude scripts *.py recursive-exclude scripts *.sh recursive-exclude tests *.py -include *.cff \ No newline at end of file From 9a231e0486a17c2b4ef7157db281be30381db8a0 Mon Sep 17 00:00:00 2001 From: "felix.bucsa" <72919584+FelixNicolaeBucsa@users.noreply.github.com> Date: Wed, 26 Jun 2024 09:16:19 +0100 Subject: [PATCH 07/13] Update .github/ISSUE_TEMPLATE/feature-request.yml Co-authored-by: S Ali Hosseini <38721653+5A11@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/feature-request.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 57392177..e7d96788 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -1,6 +1,10 @@ name: ☝️Feature request description: Suggest an idea. labels: ["enhancement", "unconfirmed"] +assignees: + - MissingNO57 + - pbukva + - jrriehl body: - type: markdown attributes: From 948d7ac4303393ec86a1fa7772a32a64af2fd948 Mon Sep 17 00:00:00 2001 From: "felix.bucsa" <72919584+FelixNicolaeBucsa@users.noreply.github.com> Date: Wed, 26 Jun 2024 09:16:25 +0100 Subject: [PATCH 08/13] Update .github/ISSUE_TEMPLATE/bug-report.yml Co-authored-by: S Ali Hosseini <38721653+5A11@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug-report.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 83f26212..f1bae36a 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,6 +1,10 @@ name: 🐛 Bug Report description: Report a bug. labels: ["bug", "unconfirmed"] +assignees: + - MissingNO57 + - pbukva + - jrriehl body: - type: markdown attributes: From 71cbbbedff03c3084a8b6dfb6edc7a4263bef0fb Mon Sep 17 00:00:00 2001 From: "felix.bucsa" <72919584+FelixNicolaeBucsa@users.noreply.github.com> Date: Wed, 26 Jun 2024 09:22:02 +0100 Subject: [PATCH 09/13] Update .github/ISSUE_TEMPLATE/bug-report.yml Co-authored-by: S Ali Hosseini <38721653+5A11@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug-report.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index f1bae36a..7ab744d8 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,6 +1,10 @@ name: 🐛 Bug Report description: Report a bug. labels: ["bug", "unconfirmed"] +assignees: + - MissingNO57 + - pbukva + - jrriehl assignees: - MissingNO57 - pbukva From fe49db6a1034c48e3b8f6207215050c3ac973ae3 Mon Sep 17 00:00:00 2001 From: "felix.bucsa" <72919584+FelixNicolaeBucsa@users.noreply.github.com> Date: Wed, 26 Jun 2024 09:23:07 +0100 Subject: [PATCH 10/13] Update .github/ISSUE_TEMPLATE/feature-request.yml Co-authored-by: S Ali Hosseini <38721653+5A11@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/feature-request.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index e7d96788..b1395f01 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -1,6 +1,10 @@ name: ☝️Feature request description: Suggest an idea. labels: ["enhancement", "unconfirmed"] +assignees: + - MissingNO57 + - pbukva + - jrriehl assignees: - MissingNO57 - pbukva From 72ad5225594eeded0b68c44af64c7c2d8512cc01 Mon Sep 17 00:00:00 2001 From: S Ali Hosseini <38721653+5A11@users.noreply.github.com> Date: Wed, 26 Jun 2024 14:18:30 +0100 Subject: [PATCH 11/13] Apply suggestions from code review --- .github/ISSUE_TEMPLATE/bug-report.yml | 4 ---- .github/ISSUE_TEMPLATE/feature-request.yml | 4 ---- 2 files changed, 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 7ab744d8..f1bae36a 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,10 +1,6 @@ name: 🐛 Bug Report description: Report a bug. labels: ["bug", "unconfirmed"] -assignees: - - MissingNO57 - - pbukva - - jrriehl assignees: - MissingNO57 - pbukva diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index b1395f01..e7d96788 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -1,10 +1,6 @@ name: ☝️Feature request description: Suggest an idea. labels: ["enhancement", "unconfirmed"] -assignees: - - MissingNO57 - - pbukva - - jrriehl assignees: - MissingNO57 - pbukva From 1dbee489373211ebfc1cf9f3e162349f7380b9b6 Mon Sep 17 00:00:00 2001 From: S Ali Hosseini <38721653+5A11@users.noreply.github.com> Date: Wed, 26 Jun 2024 15:27:07 +0100 Subject: [PATCH 12/13] Update .github/ISSUE_TEMPLATE/bug-report.yml --- .github/ISSUE_TEMPLATE/bug-report.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index f1bae36a..63415185 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -27,7 +27,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 ad0ca462a901932e1a58dd7d9d7e1592db7fd127 Mon Sep 17 00:00:00 2001 From: S Ali Hosseini <38721653+5A11@users.noreply.github.com> Date: Thu, 27 Jun 2024 13:06:47 +0100 Subject: [PATCH 13/13] Update .github/PULL_REQUEST_TEMPLATE/release.md --- .github/PULL_REQUEST_TEMPLATE/release.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/PULL_REQUEST_TEMPLATE/release.md b/.github/PULL_REQUEST_TEMPLATE/release.md index 8eb1211c..ee052259 100644 --- a/.github/PULL_REQUEST_TEMPLATE/release.md +++ b/.github/PULL_REQUEST_TEMPLATE/release.md @@ -10,6 +10,7 @@ _[briefly describe the main changes with this release]_ _Put an `x` in the boxes that apply._ +- [ ] I am making a pull request against the `main` branch from `release/v...`. - [ ] Checks and tests pass locally - [ ] I have updated the version in `pyproject.toml` - [ ] I have regenerated and updated the API docs