Skip to content

Commit

Permalink
Polished Markdown files
Browse files Browse the repository at this point in the history
  - Reflowed Markdown files to align to common standards for authoring,
    aiding source readability.

  - Added links and link references.

  - Corrected typos for spelling etc.

  - Linked to the license file from Cargo.toml.
  • Loading branch information
danwilliams committed Jun 20, 2024
1 parent f90be0d commit 88799b3
Show file tree
Hide file tree
Showing 8 changed files with 293 additions and 110 deletions.
119 changes: 87 additions & 32 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,79 +1,134 @@
# Contributor Covenant Code of Conduct for Calimero

[Contributor Covenant]: https://www.contributor-covenant.org

## 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, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
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, socio-economic status, nationality,
personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:
Examples of behavior that contributes to creating a positive environment
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

- 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
- Focusing on what is best not just for us as individuals, but for the overall
community

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 email address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
- 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 email 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 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, or to ban temporarily or permanently any contributor for other behaviors 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 within all project spaces, and 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 email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
This Code of Conduct applies within all project spaces, and 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 email 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 at `[email protected]`. All complaints will be reviewed and investigated promptly and fairly.
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at `[email protected]`. All
complaints will be reviewed and investigated promptly and fairly.

All project maintainers are obligated to respect the privacy and security of the reporter of any incident.
All project maintainers are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Project maintainers will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
Project maintainers will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### Correction

**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from project maintainers, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
**Consequence**: A private, written warning from project maintainers, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### Warning

**Community Impact**: A violation through a single incident or series of actions.
**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.
**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.

### Temporary Ban

**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
**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.
**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.

### 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.
**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.
**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 [v2.1](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.
This Code of Conduct is adapted from the [Contributor Covenant][],
version 2.1, available at [v2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).

For answers to common questions about this code of conduct, see the FAQ at [FAQ](https://www.contributor-covenant.org/faq). Translations are available at [translations](https://www.contributor-covenant.org/translations).
Community Impact Guidelines were inspired by Mozilla's code of conduct
enforcement ladder.

[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at
[FAQ](https://www.contributor-covenant.org/faq). Translations are available at
[translations](https://www.contributor-covenant.org/translations).

For more information contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
For more information contact [[email protected]](mailto:[email protected])
with any additional questions or comments.
117 changes: 79 additions & 38 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,87 +1,128 @@
# Contribution Guide

[GitPR]: https://github.com/susam/gitpr
[Issues]: https://github.com/calimero-network/core/issues
[README]: README.mdx

Thank you for dedicating your time to contribute to our project.

This guide outlines the contribution workflow to make the process smooth and effective for everyone.
This guide outlines the contribution workflow to make the process smooth and
effective for everyone.

Start by reading the README to understand the project better.
Start by reading the [README][] to understand the project better.

## Project Status

This project is actively being developed.

You can check out the open Issues, monitor the development progress, and contribute.
You can check out the open [Issues][], monitor the development progress, and
contribute.

## Getting Started

There are several ways you can contribute:

- Solve open issues
- Report bugs or suggest features
- Enhance the documentation
- Solve open [Issues][]
- Report bugs or suggest features
- Enhance the documentation

Contributions are managed via Issues and Pull Requests (PRs). Here are some
general guidelines:

- Before creating a new Issue or PR, search for [existing ones][Issues].

- Contributions should focus on either functionality or style in the PR, not
both.

- If you encounter an error, provide context. Explain what you are trying to
do and how to reproduce the error.

Contributions are managed via Issues and Pull Requests (PRs). Here are some general guidelines:
- Follow the repository’s formatting guidelines.

- Before creating a new Issue or PR, search for [existing ones](https://github.com/calimero-network/core/issues).
- Contributions should focus on either functionality or style in the PR, not both.
- If you encounter an error, provide context. Explain what you are trying to do and how to reproduce the error.
- Follow the repository’s formatting guidelines.
- Update the README.md file if your changes affect it.
- Update the [README][] file if your changes affect it.

## Issues

Use Issues to report problems, request features, or discuss changes before creating a PR.
Use [Issues][] to report problems, request features, or discuss changes before
creating a PR.

### Solving an Issue

Browse [existing issues](https://github.com/calimero-network/core/issues) to find one that interests you.
Browse [existing issues][Issues] to find one that interests you.

## Contribution Guidelines for Working on Issues

If someone is already working on an issue, they will either be officially assigned to it or have left a comment indicating they are working on it. If you would like to work on an issue, please follow these steps:
If someone is already working on an issue, they will either be officially
assigned to it or have left a comment indicating they are working on it. If you
would like to work on an issue, please follow these steps:

1. **Comment on the Issue**: Leave a comment on the issue expressing your intention to work on it. For example, "I would like to work on this issue."
2. **Wait for Confirmation**: A project maintainer will confirm your assignment by officially assigning the issue to you or by acknowledging your comment.
3. **Start Working**: Once you have received confirmation, you can start working on the issue.
4. **Open a Pull Request**: When your work is ready, open a pull request (PR) with your solution. Make sure to mention in the PR that you are working on the issue by referencing the issue number in the PR description (e.g., "This PR addresses issue #123").
1. **Comment on the Issue**: Leave a comment on the issue expressing your
intention to work on it. For example, "I would like to work on this issue."

By following this process, we can avoid duplication of efforts and ensure clear communication among all contributors.
2. **Wait for Confirmation**: A project maintainer will confirm your
assignment by officially assigning the issue to you or by acknowledging
your comment.

3. **Start Working**: Once you have received confirmation, you can start
working on the issue.

4. **Open a Pull Request**: When your work is ready, open a pull request (PR)
with your solution. Make sure to mention in the PR that you are working on
the issue by referencing the issue number in the PR description (e.g.,
"This PR addresses issue #123").

By following this process, we can avoid duplication of efforts and ensure clear
communication among all contributors.

### Creating a New Issue

If no related issue exists, you can create a new one.

Here are some tips:

- Provide detailed context to make it clear for others.
- Include steps to reproduce the issue or the rationale for a new feature.
- Attach screenshots, videos, etc., if applicable.
- Provide detailed context to make it clear for others.
- Include steps to reproduce the issue or the rationale for a new feature.
- Attach screenshots, videos, etc., if applicable.

## Pull Requests

### Pull Request Workflow

We use the ["fork-and-pull"](https://github.com/susam/gitpr) Git workflow:
We use the ["fork-and-pull"][GitPR] Git workflow:

1. Fork the repository.

2. Clone the project.

1. Fork the repository.
2. Clone the project.
3. Create a new branch with a descriptive name.
4. Commit your changes to this new branch.
5. Push your changes to your fork.
6. Create a pull request from your fork to our repository. Use the "master" branch as the base branch.
7. Tag a maintainer to review your PR.
3. Create a new branch with a descriptive name.

4. Commit your changes to this new branch.

5. Push your changes to your fork.

6. Create a pull request from your fork to our repository. Use the `master`
branch as the base branch.

7. Tag a maintainer to review your PR.

### Tips for a Quality Pull Request

- Title your PR to clearly describe the work done.
- Structure the description for easy reading, using bullet points and screenshots if necessary.
- Link to the related issue, if applicable.
- Write a concise commit message summarizing the work.
- Title your PR to clearly describe the work done.

- Structure the description for easy reading, using bullet points and
screenshots if necessary.

- Link to the related issue, if applicable.

- Write a concise commit message summarizing the work.

### After Submitting Your PR

- We might ask questions, request more details, or ask for changes before merging your PR. This ensures clarity and smooth interaction.
- As you update your PR, resolve each conversation.
- Once approved, we will "squash-and-merge" to keep the commit history clean.
- We might ask questions, request more details, or ask for changes before
merging your PR. This ensures clarity and smooth interaction.

- As you update your PR, resolve each conversation.

- Once approved, we will "squash-and-merge" to keep the commit history clean.

Thank you for your contributions!
21 changes: 16 additions & 5 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,22 @@

# Contributors to Calimero

[Apache license]: https://www.apache.org/licenses/LICENSE-2.0
[DCO]: https://developercertificate.org/

We contributors to Calimero:

* License all our contributions to the project under the Apache License, Version 2.0
* Have the legal rights to license our contributions ourselves, or get permission to license them from our employers, clients, or others who may have them
* Signoff on our commits with the [Developer Certificate of Origin (DCO) Version 1.1](https://developercertificate.org/)
* Previously we added our names and GitHub handles to this CONTRIBUTORS.md file. We leave these names here to record the commits that came before.
* License all our contributions to the project under the [Apache License,
Version 2.0][Apache license].

* Have the legal rights to license our contributions ourselves, or get
permission to license them from our employers, clients, or others who may
have them.

* Sign off on our commits with the [Developer Certificate of Origin (DCO)
Version 1.1][DCO].

* Previously we added our names and GitHub handles to this
`CONTRIBUTORS.md` file. We leave these names here to record the commits that
came before.

-----------
1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ authors = ["Calimero Limited <[email protected]>"]
edition = "2021"
repository = "https://github.com/calimero-network/core"
license = "MIT OR Apache-2.0"
license-file = "LICENSE.md"

[workspace]
resolver = "2"
Expand Down
Loading

0 comments on commit 88799b3

Please sign in to comment.