edits: changes to files in gh repo

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -1,60 +1,82 @@
 name: 🐛 Bug Report
-description: Report a reproducible bug.
-title: "Bug report: <short description>"
+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://docs.fetch.ai/CosmPy/#version).
+        - label: I checked the [documentation](https://fetch.ai/docs) and found no answer to my problem
           required: true
-        - label: I checked the [documentation](http://docs.fetch.ai/CosmPy/) 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 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

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -1,51 +1,34 @@
-name: ☝️ Feature request
-description: Suggest an idea for this project
-title: "Feature request: <short description>"
+name: ☝️Feature request
+description: Suggest an idea.
 labels: ["enhancement", "unconfirmed"]
 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

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

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

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: "2021-06-01"
+url: "https://github.com/fetchai/cosmpy"
+license: "Apache-2.0"

CODE_OF_CONDUCT.md

@@ -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 the <https://www.contributor-covenant.org>, version 2.1, available at <https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.
 
 Community Impact Guidelines were inspired by [Mozilla’s code of conduct enforcement ladder](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>.