edits: changes to files in gh repo

.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

.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...]_

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 <https://www.contributor-covenant.org>, version 2.1,
-available at <https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.
+This Code of Conduct is adapted from <https://www.contributor-covenant.org>, version 2.1, available at <https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.
 
 Community Impact Guidelines were inspired by [Mozilla’s code of conduct enforcement ladder](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>. Translations are available at <https://www.contributor-covenant.org/translations>.
+For answers to common questions about this code of conduct, see the FAQ at: <https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.

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)
 
 ## <a name="coc"></a> Code of Conduct
 
-Please read and follow our [Code of Conduct][coc].
+<!-- markdown-link-check-disable -->
+Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md).
+<!-- markdown-link-check-enable -->
 
 ## <a name="question"></a> 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:
+<!-- markdown-link-check-disable -->
+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:
+<!-- markdown-link-check-enable -->
 
 - 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,32 +43,40 @@ If you would like to *implement* a new feature:
 
 ### <a name="submit-issue"></a> 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.
+<!-- markdown-link-check-disable -->
+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.
+<!-- markdown-link-check-enable -->
 
 ### <a name="submit-pr"></a> 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.
+    <!-- markdown-link-check-disable -->
+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.
+    <!-- markdown-link-check-enable -->
 
 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].
+    <!-- markdown-link-check-disable -->
+4. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the [repository](https://github.com/fetchai/cosmpy).
+    <!-- markdown-link-check-enable -->
 
 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, as described in the [development guide][developing], and ensure they pass. This saves CI hours and ensures you only commit clean code.
+    <!-- markdown-link-check-disable -->
+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.
+    <!-- markdown-link-check-enable -->
 
 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.
+<!-- markdown-link-check-disable -->
+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.
+<!-- markdown-link-check-enable -->
 
 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.
+<!-- markdown-link-check-disable -->
+- All code must pass our code quality checks (linters, formatters, etc). See the [development guide](DEVELOPING.md) section for more detail.
+<!-- markdown-link-check-enable -->
+
 - 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
 
 ## <a name="commit"></a> 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
+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/).
+
+## <a name="merge"></a> 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.

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. 🙇