Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Align with Governance audit #79

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .github/workflows/ISSUE TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
blank_issues_enabled: true
contact_links:
- name: Contributing guidelines
url: https://github.com/bech32/blob/master/CONTRIBUTING.md
about: Some rules & processes we honor.

- name: Feature ideas
url: https://github.com/bech32/discussions/categories/ideas
about: Maybe someone else had the same or a similar idea already?

- name: All issues
url: https://github.com/bech32/issues
about: Check whether your issue is not already covered here.
43 changes: 43 additions & 0 deletions .github/workflows/ISSUE TEMPLATE/feature_idea_bech.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Feature idea Bech32
description: Idea or request for some feature on the bech32 repository
labels: [':thought_balloon: idea']
body:
- type: markdown
attributes:
value: |
**Thank you for contributing to our project!** :green_heart:

Instead of opening this issue, consider [starting a new idea discussion](https://github.com/IntersectMBO/bech32/discussions/new?category=ideas).
That way, we can discuss & refine your idea together, before we adopt it as a feature into the roadmap.

- type: textarea
id: why
attributes:
label: Why
description: Why do we need or want this feature
placeholder: |
Give context and describe the problem, challenge or opportunity you see
validations:
required: true

- type: textarea
id: what
attributes:
label: What
description: What is this feature roughly about
placeholder: |
For example describe a new API endpoint, a change in messaging formats,
a new configuration option, ...
validations:
required: true

- type: textarea
id: how
attributes:
label: How
description: How could we realize this feature
placeholder: |
Which technical solutions, libraries or systems should be used, which
components need to change, steps how to implement this, ...
validations:
required: true
3 changes: 3 additions & 0 deletions .github/workflows/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## List of changes

- Added / Fixed / Changed / Removed
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## Changelog

Changelogs for components can be found as follows:

- [bech32-th](https://github.com/IntersectMBO/cardano-node/blob/master/bech32-th/ChangeLog.md)
- [bech32](https://github.com/IntersectMBO/cardano-node/blob/master/bech32/ChangeLog.md)

129 changes: 127 additions & 2 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,128 @@
See [code of conduct].
# Contributor Covenant Code of Conduct

[code of conduct]: https://github.com/input-output-hk/cardano-engineering-handbook/blob/main/CODE-OF-CONDUCT.md
## Our Pledge

We as members, contributors, and leaders pledge to make participation in 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, 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 for our
community include:

* Demonstrating empathy and kindness toward other people
* 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 not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* 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
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders 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, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our 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 to the community leaders responsible for enforcement at
.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders 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 leaders, 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, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in 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, including unsolicited interaction
with those enforcing the Code of Conduct, 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.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

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.
85 changes: 85 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,88 @@ Pull requests are welcome!

When creating a pull request, please make sure that your code adheres to our
[coding standards](https://github.com/input-output-hk/adrestia/blob/master/docs/code/Coding-Standards.md).

# Contributing to Bech32

Thank you for considering helping out! We're glad you're reading this because we need volunteer developers to help this project come to fruition.
Looking to update information or feature your project? Feel free to make the change yourself.
First, please read the code of conduct. We take it very seriously!
Next, if you want to help out, do the following:
Fork the project.
Make a feature branch with the name of your change.
Make a change.
Commit your code.
Issue a Pull Request.
Once your PR is issued, we will review your work and decide to add it to the project!
For more details about contributing to GitHub projects, see How to use Github: Fork, Branch, Track, Squash, and Pull Request.

## Types of contribution

Provide information on what kinds of contributions your project is looking for here. For example, these can be bug reports, help answering user questions, improving documentation, bug fixes, and new feature implementations.

## Openness

The configuration of an open project enables frictionless contributing. Projects should be discoverable and well-documented. Anyone within our Intersect MBO should be able to find a desired project and ramp up without direct guidance from host team members.

## Code of Conduct

[The Code of Conduct](https://github.com/IntersectMBO/OSC-documentation/blob/master/CODE-OF-CONDUCT.md) governs this project and everyone participating. By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]](https://github.com/IntersectMBO/committee-documentation-template/blob/main/[email protected]).

## Reporting Bugs

If you are subject to or witness unacceptable behavior or have any other concerns, please notify a community organizer as soon as possible.

## Feature requests

Add information on how to submit feature requests here. Also, include information on what contributors can expect regarding time first to respond and process after that.

## Contributing documentation

Include information on any documentation best practices your project follows, how to build documentation, checks to run, and how to submit the changes made back to the project.

## Transparency

For guest teams to be able to contribute meaningfully to a project, the host team must be transparent. This means that guest teams should be able to have an understanding of:

- The project/repo and its direction
- Outstanding feature requirements
- Progress on feature requirements
- Decision-making of the host team

## Prioritized Mentorship

Mentorship from the host team to the guest team via maintainers is crucial to Intersect MBO. Contributors on guest teams are up-leveled so that they understand enough about the host team’s project/repo to change it successfully.

## Voluntary Code Contribution

When contributing to this project, you must agree that you have authored 100% of the content, have the necessary rights to the content, and that the content you contribute may be provided under the project license.

## Your First Code Contribution

Need help determining where to begin contributing to [bech32](https://github.com/IntersectMBO/bech32)? You can start by looking through these `beginner` and `help-wanted` issues:

- `Beginner` issues - issues that should only require a few lines of code and a test or two.
- `Help wanted` issues - issues which should be a bit more involved than `beginner` issues.

## Styleguides

Your work will be much appreciated if you follow these style guides in your contributions.

### Git Commit Messages

- Use the present tense ("Add feature," not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line

### [Programming Language One] Styleguide


### Documentation Styleguide

Use Markdown for documentation.
Following [best practices](https://www.markdownguide.org/basic-syntax/).

## License

By contributing, you agree that your contributions will be licensed under its Apache 2.0 License.
18 changes: 18 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Security Policy

## Reporting a Vulnerability

Please report (suspected) security vulnerabilities to [email protected]. You will receive a
response from us within 48 hours. If the issue is confirmed, we will release a patch as soon
as possible.

Please provide a clear and concise description of the vulnerability, including:

* the affected version(s) of bech32,
* steps that can be followed to exercise the vulnerability,
* any workarounds or mitigations

If you have developed any code or utilities that can help demonstrate the suspected
vulnerability, please mention them in your email but ***DO NOT*** attempt to include them as
attachments as this may cause your Email to be blocked by spam filters.
See the security file in the [Cardano engineering handbook](https://github.com/input-output-hk/cardano-engineering-handbook/blob/main/SECURITY.md).
Loading