Merge pull request #1 from nabla-studio/giorgionocera_wip_documentation

Provide basic documentation for the repo

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,130 @@
+# Cosmos TXs Tracer Contributor Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers to make participation in our project and 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.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment include:
+
+- Using welcoming and inclusive language
+- 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 for the overall community
+- Demonstrating empathy and kindness toward other people
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and unwelcome 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 any electronic
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Project maintainers 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, or to ban temporarily or permanently any
+contributor for other behaviors that they deem inappropriate, threatening,
+offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within the community spaces and in public
+spaces when an individual is representing the project or its community.
+Examples of representing a project or 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 by contacting the project team. All complaints will be reviewed and
+investigated and will result in a response that is deemed necessary and
+appropriate to the circumstances. The project team is obligated to maintain
+confidentiality with regard to the reporter of an incident.
+
+## Enforcement Guidelines
+
+Community maintainers 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.
+
+**Consequence**: A private, written warning from community maintainers,
+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.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved for a specified period of time. This
+includes avoiding interactions in project and 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.
+
+**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 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.
+
+**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].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][mozilla coc].
+
+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

.github/CONTRIBUTING.md

@@ -0,0 +1,100 @@
+# Contributing in Cosmos TXs Tracer 🔍<!-- omit in toc -->
+
+First of all, thanks for investing your time in contributing this project! :partying_face: :hugs:
+
+The following guide will help you in workflow for Contributing to Cosmos TXs Tracer, as opening an issue or creating a PR. Feel free to propose changes to this document in a pull request. To get an overview of the project, read the [README](README.md).
+
+## I have a question. How can I ask? :thinking_face:
+
+> **Note:** Please don't create an issue to simply ask a question. You'll get faster results by using our channels like:
+
+- [Official nabla Discord server](https://discord.gg/WzXYRd3AwH) (**recommended**) :gear:
+- [nabla Official Twitter account](https://twitter.com/nabla_hq) :bulb:
+
+## How Can I Contribute? :handshake:
+
+### Reporting Bugs :bug:
+
+This section guides you through submitting a bug report for Cosmos TXs Tracer. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behavior :computer:, and find related reports (when exists) :mag_right:.
+
+#### Before Submitting A Bug Report :ballot_box_with_check:
+
+- **Check if you can reproduce** the problem in the **latest version** of Cosmos TXs Tracer.
+- **Perform a [cursory search](https://github.com/search?q=is%3Aissue+repo%3Anabla-studio%2Fcosmos-txs-tracer)** to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one.
+
+> **Note:** If you find a **Closed** issue which seems to describe your issue, open a new one and reference the original issue in the body of your new one.
+
+#### How to submit a Bug Report? :incoming_envelope:
+
+Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue on this repository and provide the needed information by filling in [the template](https://github.com/nabla-studio/cosmos-txs-tracer/issues/new?assignees=&labels=bug&template=BUG-REPORT.yml&title=%5BBug%5D%3A+).
+
+You have to completely explain the problem and include additional details to help maintainers reproduce the problem:
+
+- **Choose a clear and descriptive title** for the issue to identify the related problem.
+- **Describe the exact steps to reproduce the problem** in as many details as possible. For example, start by explaining what action you produced. When listing steps, don't just say what you did, but explain **how** you did it. For example, if you reached a page, explain if you reached from direct link, or tapping some buttons.
+- **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
+- **Explain which behavior you expected to see instead and why.**
+- **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem.
+- **Include your public addresses**, if available
+- **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below.
+
+Provide more context by answering:
+
+- **Is it possible to reliably reproduce this issue?** If not, please try to provide details about how often the problem happens and under which conditions it normally happens.
+### Suggesting Enhancements :sparkles:
+
+This section guides you through submitting an enhancement suggestion for Cosmos TXs Tracer, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion :pencil: and find related suggestions :mag_right:.
+
+#### Before Submitting An Enhancement Suggestion :ballot_box_with_check:
+
+- **Perform a [cursory search](https://github.com/search?q=is%3Aissue+repo%3Anabla-studio%2Fcosmos-txs-tracer)** to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
+
+#### How to submit a Enhancement Suggestion? :incoming_envelope:
+
+Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue on this repository and provide the needed information by filling in [the template](https://github.com/nabla-studio/cosmos-txs-tracer/issues/new?assignees=&labels=enhancement%2Cimprovement&template=ENHANCEMENT-REPORT.yml&title=%5BEnhancement%5D%3A+).
+
+You have to explain the suggestion you want to propose and include additional details to help maintainers understand the suggestion:
+
+- **Use a clear and descriptive title** for the issue to identify the suggestion.
+- **Describe the current behavior** and **explain which behavior you expected to see instead** and why, by explaining as many steps as you can to correctly understand the whole story.
+- **Include screenshots and animated GIFs** which help you demonstrate the steps or point out the part of Cosmos TXs Tracer which the suggestion is related to.
+- **Explain why this enhancement would be useful** to most Cosmos TXs Tracer users.
+- **List, if there exist, some other Mobile Wallet or similar services where this enhancement exists.**
+
+### How to provide solutions :construction::heavy_plus_sign:
+
+We love pull requests. Please follow these steps to have your contribution considered by the maintainers:
+
+#### Getting Started :beginner:
+
+1. Make sure you have a [**GitHub account**](https://github.com/signup/free>).
+2. If you want to help in fixing a bug or to propose a solution for an improvement, firstly **check if there exists a related issue**. Otherwise **create a new one following the above documentation**.
+3. **Fork the repository** on GitHub.
+4. **Create a branch** for your edits starting by the `main` one.
+
+#### Commit your update :new:
+
+Commit the changes once you are happy with them. We use conventional commits on our repo, so please, **follow that convention**.
+
+Once your changes are ready, don't forget to self-review to speed up the review process :zap:.
+
+#### Pull Request :twisted_rightwards_arrows:
+
+When you're finished with the changes, create a pull request, also known as a PR.
+
+1. **Fill the "Pull Request" template** to help the reviewers understanding your changes as well as the purpose of your pull request.
+2. Don't forget to [**link PR to issue**](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
+3. **Enable the checkbox** to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge.
+
+Once you submit your PR, a team member will review your proposal. We may ask questions or request for additional information.
+
+- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
+- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
+
+#### Thank you! :pray:
+
+Congratulations, your work is now available to the whole nabla community. :tada::clap:
+
+The nabla team thanks you :sparkles:.
+
+We also thanks to Github and Faker.py team for their contributing guides.

.github/ISSUE_TEMPLATE/BUG-REPORT.yml

@@ -0,0 +1,46 @@
+---
+name: "\U0001F41B Bug Report"
+description: "If something isn't working as expected \U0001F914"
+title: '[Bug]: '
+labels: ['bug']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: checkboxes
+    id: prerequisites
+    attributes:
+      label: Prerequisites
+      description: Ensure to have completed the submission checklist
+      options:
+        - label: You read the guidelines for contributing.
+          required: true
+        - label: You are able to reproduce the problem in the latest version of Cosmos TXs Tracer.
+          required: true
+        - label: You checked that the problem has not yet been reported (also through closed issues).
+          required: true
+  - type: textarea
+    id: step-description
+    attributes:
+      label: Describe the exact steps to reproduce the problem in as many details as possible
+      description: When listing steps, don’t just say what you did, but explain how you did it.
+      placeholder: Tell us what you did to obtain the issue.
+    validations:
+      required: true
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Describe the issue behavior
+      description: Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
+      placeholder: Tell us what you see.
+    validations:
+      required: true
+  - type: textarea
+    id: txs
+    attributes:
+      label: Transactions
+      description: Please insert some transaction hashes to guarantee a deeper debug (it is not required, but could help!).
+      placeholder: ex. BB53FB...
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/ENHANCEMENT-REPORT.yml

@@ -0,0 +1,44 @@
+---
+name: "\U0001F680 Enhancement Proposal Report"
+description: "If I think something could be improved \U00002692"
+title: '[Enhancement]: '
+labels: ['enhancement', 'improvement']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this enhancement report!
+  - type: checkboxes
+    id: prerequisites
+    attributes:
+      label: Prerequisites
+      description: Ensure to have completed the submission checklist
+      options:
+        - label: You read the guidelines for contributing.
+          required: true
+        - label: You checked that the enhancement has not yet been reported (also through closed issues).
+          required: true
+  - type: textarea
+    id: enhancement-description
+    attributes:
+      label: Describe the current behavior
+      description: Describe the current behavior and explain which behavior you expected to see instead and why, by explaining as many steps as you can to correctly understand the whole story.
+      placeholder: Tell us what you see and what you what you would like to see.
+    validations:
+      required: true
+  - type: textarea
+    id: usage-description
+    attributes:
+      label: Explain the motivation
+      description: Explain why this enhancement would be useful to most Cosmos TXs Tracer users.
+      placeholder: Tell us why we should work on this enhancement.
+    validations:
+      required: true
+  - type: textarea
+    id: references
+    attributes:
+      label: Provide a list of references
+      description: List, if there exist, some other mobile Wallet or similar services where this enhancement exists.
+      placeholder: Tell us who else provides this enhancement.
+    validations:
+      required: false

.github/pull_request_template.md

@@ -0,0 +1,21 @@
+### :nerd_face: Describe the purpose of the Pull Request
+
+Describe the big picture of your changes, to communicate to the maintainers why they should accept this pull request.
+
+### :rotating_light: Ensure to have answered all the submission questions
+
+- [ ] You read the guidelines for contributing.
+- [ ] You correctly created an issue about the things you want to solve with this PR.
+- [ ] You are requesting to **pull a topic/feature/bugfix branch** (right side). Don't request your master!
+- [ ] You checked the commits' message styles matches our requested structure.
+- [ ] You added necessary documentation (where needed).
+- [ ] You performed fully tests on your code.
+- [ ] You are introducing breaking changes.
+
+### :link: Issue linking
+
+Please, provide the id of the issues you want to solve with this PR.
+
+### :heart: Thanks!
+
+Thanks for taking the time in contributing to Cosmos TXs Tracer!