Skip to content

Commit

Permalink
chore: update docs; comply with the template
Browse files Browse the repository at this point in the history
  • Loading branch information
itsyaasir authored and qrayven committed Nov 19, 2024
1 parent c2809be commit 782e631
Show file tree
Hide file tree
Showing 10 changed files with 614 additions and 16 deletions.
64 changes: 64 additions & 0 deletions .github/CODE_OF_CONDUCT
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project, and our community, a harassment-free experience for everyone regardless of:
- Age
- Body size
- Disability
- Ethnicity
- Sex characteristics
- Gender identity and expression
- Level of experience
- Education
- Socioeconomic status
- Nationality
- Personal appearance
- Race
- Religion
- Sexual identity and orientation

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

- Using welcoming and inclusive language.
- Being respectful of differing viewpoints and experiences.
- Gracefully accepting constructive criticism.
- Focusing on what is best for the community.
- Showing empathy towards other community members.

Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual attention or
advances.
- Trolling, insulting/derogatory comments, and personal or political attacks.
- Public or private harassment.
- Publishing others' private information, such as a physical or electronic address, without 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 instances of unacceptable behavior.

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. Project maintainers may temporarily or permanently ban any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies within all project spaces. It also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include:
- Using an official project e-mail address.
- Posting via an official social media account.
- Acting as an appointed representative at an online or offline event.

Project maintainers may further define and clarify what is meant by representation of a project.

## Enforcement

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
89 changes: 89 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: "bug"
body:
- type: markdown
attributes:
value: Before raising an issue, please search for existing [issues](https://github.com/iotaledger/template/labels/bug) to avoid creating duplicates. For questions and support please use [Discord](https://discord.iota.org).
- type: textarea
id: bug-description
attributes:
label: Bug description
description: Summarize the bug encountered concisely
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: Describe what you should see instead
- type: dropdown
id: can_repro
attributes:
label: Can the issue reliably be reproduced?
options:
- 'Yes'
- 'No'
validations:
required: true
- type: input
id: example-repository
attributes:
label: Example repository
description: If possible, please create a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug and link it here in the bug report.
- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to reproduce
description: Describe the steps to reproduce the issue
placeholder: |
1.
2.
3.
- type: dropdown
id: language
attributes:
label: Language
description: What programming language are you using?
options:
- Rust
- WASM
- Node.js
- Python
- Java
- C
- Go
validations:
required: true
- type: input
id: language-version
attributes:
label: Language Version
description: Which version of the language did you use?
placeholder: v1.0.0
validations:
required: true
- type: input
id: version
attributes:
label: Version
description: Which version of our software are you using?
placeholder: version number, commit and/or branch
validations:
required: true
- type: textarea
id: hardware
attributes:
label: Hardware specifications
description: What hardware are you using?
value: |
- Operating system:
- RAM:
- Cores:
- Device:
- type: textarea
id: anything-else
attributes:
label: Additional info
description: Let us know if you have any additional info like logs, erros or screenshots
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Join our Discord
url: https://discord.iota.org/
about: Chat with the devs and the IF community
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Feature Request
description: Request a feature
title: "[Request]: "
labels: "request"
body:
- type: markdown
attributes:
value: Before requesting a feature, please search for existing [feature requests](https://github.com/iotaledger/template/labels/request) to avoid creating duplicates.
- type: textarea
id: feature-description
attributes:
label: Feature description
description: Briefly describe the feature that you are requesting.
validations:
required: true
- type: textarea
id: motivation
attributes:
label: Motivation
description: Explain why this feature is needed.
validations:
required: true
- type: textarea
id: requirements
attributes:
label: Requirements
description: Write a list of what you want this feature to do.
placeholder: |
1.
2.
3.
validations:
required: true
- type: textarea
id: open-questions
attributes:
label: Open questions
description: Use this section to ask any questions that are related to the feature.
- type: dropdown
id: pull-request
attributes:
label: Are you planning to do it yourself in a pull request?
options:
- "Yes"
- "No"
validations:
required: true
34 changes: 34 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Description of change

<!-- Please write a summary of your changes and why you made them. -->

## Links to any relevant issues

<!-- Be sure to reference any related issues by adding `fixes #issue_number`. -->

## Type of change

<!-- Choose a type of change, and delete any options that are not relevant. -->

- Bug fix (a non-breaking change which fixes an issue)
- Enhancement (a non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing functionality to not work as expected)
- Documentation Fix

## How the change has been tested

<!-- Describe the tests that you ran to verify your changes. -->

<!-- Make sure to provide instructions for the maintainer as well as any relevant configurations. -->

## Change checklist

<!-- Tick the boxes that are relevant to your changes, and delete any items that are not. -->

- [ ] I have followed the contribution guidelines for this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have checked that new and existing unit tests pass locally with my changes
- [ ] I have updated the CHANGELOG.md, if my changes are significant enough
145 changes: 145 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
# Contribute to secret-storage

This document describes how to contribute to secret-storage.
We encourage everyone with knowledge and passion in IOTA technology to do so.

Thanks! :heart:

<details>
<summary>Do you have a question :question:</summary>
<br>

If you have a general or technical question, you can use one of the following resources instead of submitting an issue:

- [**Developer documentation:**](https://wiki.iota.org/) For official information about developing with IOTA technology
- [**Discord:**](https://discord.iota.org/) For real-time chats with the developers and community members
- [**IOTA Governance:**](https://govern.iota.org/) For technical, research or governance discussions with the Research and Development Department at the IOTA Foundation
- [**StackExchange:**](https://iota.stackexchange.com/) For technical and troubleshooting questions

</details>

<br>

<details>
<summary>Ways to contribute :mag:</summary>
<br>

To contribute to wallet on GitHub, you can:

- Report a bug
- Suggest a new feature
- Build a new feature

</details>

<br>

<details>
<summary>Report a bug :bug:</summary>
<br>

This section guides you through reporting a bug. Following these guidelines helps maintainers and the community understand the bug, reproduce the behavior, and find related bugs.

### Before reporting a bug

Please check the following list:

- **Do not open a GitHub issue for [security vulnerabilities](.github/SECURITY.MD)**, instead, please contact us at [[email protected]](mailto:[email protected]).

- **Ensure the bug was not already reported** by searching on GitHub under [**Issues**](https://github.com/iotaledger/template/issues). If the bug has already been reported **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 that seems similar to what you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

### Submitting a bug report

To report a bug, [open a new issue](https://github.com/iotaledger/template/issues/new), and be sure to include as many details as possible, using the template.

**Note:** Minor changes such as fixing a typo can but do not need an open issue.

If you also want to fix the bug, submit a [pull request](#pull-requests) and reference the issue.
</details>

<br>

<details>
<summary>Suggest a new feature :bulb:</summary>
<br>

This section guides you through suggesting a new feature. Following these guidelines helps maintainers and the community collaborate to find the best possible way forward with your suggestion.

### Before suggesting a new feature

**Ensure the feature has not already been suggested** by searching on GitHub under [**Issues**](https://github.com/iotaledger/template/labels/request).

### Suggesting a new feature

To suggest a new feature, open a [Feature Request](https://github.com/iotaledger/template/issues/new?template=feature_request.yml).

</details>

<br>

<details>
<summary>Build a new feature :hammer:</summary>
<br>

This section guides you through building a new feature. Following these guidelines helps give your feature the best chance of being approved and merged.

### Before building a new feature

Make sure to discuss the feature in [Discussions](https://github.com/iotaledger/template/discussions)

Otherwise, your feature may not be approved at all.

### Building a new feature

To build a new feature, check out a new branch based on the <!-- TODO Choose branch --> `develop` branch, and be sure to document any public-facing APIs, using code comments.
</details>

<br>

<details>
<summary>Pull requests :mega:</summary>
<br>

This section guides you through submitting a pull request (PR). Following these guidelines helps give your PR the best chance of being approved and merged.

### Before submitting a pull request

Before submitting a pull request, please follow these steps to have your contribution considered by the maintainers:

- A pull request should have exactly one concern (for example one feature or one bug). If a PR addresses more than one concern, it should be split into two or more PRs.

- A pull request can be merged only if it references an open issue

**Note:** You don't need to open an issue for minor changes such as typos, but you can if you want.

<!-- TODO
Add project specific requirements like formatting, linting, tests, comments, license and so on
-->

### Submitting a pull request

The following is a typical workflow for submitting a new pull request:

<!-- TODO
You may add project specific steps and change the branch
-->

1. Fork this repository
2. Create a new branch based on your fork. For example, `git checkout -b fix/my-fix` or `git checkout -b feat/my-feature`.
3. Commit changes and push them to your fork
4. Target your pull request to be merged with `develop`

If all [status checks](https://help.github.com/articles/about-status-checks/) pass, and the maintainer approves the PR, it will be merged.

**Note:** Reviewers may ask you to complete additional work, tests, or other changes before your pull request can be approved and merged.
</details>

<br>

<details>
<summary>Code of Conduct :clipboard:</summary>
<br>

This project and everyone participating in it is governed by the [Code of Conduct](.github/CODE_OF_CONDUCT.md).
Loading

0 comments on commit 782e631

Please sign in to comment.