Skip to content

Commit

Permalink
docs(react): write 3.0 changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
cschroeter committed May 23, 2024
1 parent cff4763 commit c907e94
Show file tree
Hide file tree
Showing 15 changed files with 505 additions and 218 deletions.
2 changes: 1 addition & 1 deletion .prettierrc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"htmlWhitespaceSensitivity": "ignore",
"overrides": [
{
"files": "*.mdx",
"files": "*.md",
"options": {
"printWidth": 100,
"proseWrap": "always"
Expand Down
69 changes: 31 additions & 38 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,68 +2,61 @@

## 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
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 a positive environment for our
community include:
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
- 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
- The use of sexualized language or imagery, and sexual attention or advances
- 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
- 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

## Our Responsibilities

Project maintainers are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers are responsible for clarifying and enforcing our standards of acceptable
behavior and will 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 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.
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 <[email protected]>.
All complaints will be reviewed and investigated promptly and fairly.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community
leaders responsible for enforcement at <[email protected]>. 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.
All community leaders are obligated to respect the privacy and security of the reporter of any
incident.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/), version
[1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and
[2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md).
This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/),
version [1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md)
and [2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md).
21 changes: 16 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Contributing to Ark UI

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
We love your input! We want to make contributing to this project as easy and transparent as
possible, whether it's:

- Reporting a bug
- Discussing the current state of the code
Expand All @@ -9,13 +10,23 @@ We love your input! We want to make contributing to this project as easy and tra
- Becoming a maintainer

## Report bugs using Github's [issues](https://github.com/chakra-ui/ark/issues)
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/chakra-ui/ark/issues/new); it's that easy!

We use GitHub issues to track public bugs. Report a bug by
[opening a new issue](https://github.com/chakra-ui/ark/issues/new); it's that easy!

## License
By contributing, you agree that your contributions will be licensed under its [Licesne](https://github.com/chakra-ui/ark/blob/main/LICENSE).

By contributing, you agree that your contributions will be licensed under its
[Licesne](https://github.com/chakra-ui/ark/blob/main/LICENSE).

## Discuss changes before starting to work on them
Please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. This helps everyone to be on the same page and makes the chances of your contributions being integrated into the project much higher.

Please first discuss the change you wish to make via issue, email, or any other method with the
owners of this repository before making a change. This helps everyone to be on the same page and
makes the chances of your contributions being integrated into the project much higher.

## Do a self-review before requesting a review from others
Before requesting a review for your pull request, do a self-review. Go through your code additions and make sure they follow the coding practices and guidelines of the project. This helps to streamline the review process and reduce the iteration cycles of review.

Before requesting a review for your pull request, do a self-review. Go through your code additions
and make sure they follow the coding practices and guidelines of the project. This helps to
streamline the review process and reduce the iteration cycles of review.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@

## What is Ark UI?

Ark UI is a headless, open-source UI library with over 30+ components designed for building reusable, scalable Design Systems. It supports a wide range of JavaScript frameworks, offering dedicated packages for each supported framework.
Ark UI is a headless, open-source UI library with over 30+ components designed for building
reusable, scalable Design Systems. It supports a wide range of JavaScript frameworks, offering
dedicated packages for each supported framework.

## Components

Expand Down Expand Up @@ -51,16 +53,20 @@ Ark UI is a headless, open-source UI library with over 30+ components designed f

## Documentation

For more detailed documentation and examples, please visit the [official documentation](https://ark-ui.com/).
For more detailed documentation and examples, please visit the
[official documentation](https://ark-ui.com/).

## Roadmap

You can request, vote for, and check upcoming features on our [roadmap](https://ark-ui.canny.io/).

## Contribution

We welcome contributions to Ark UI. Please read our [contributing guidelines](https://github.com/chakra-ui/ark/blob/main/CONTRIBUTING.md) for more information on how to contribute.
We welcome contributions to Ark UI. Please read our
[contributing guidelines](https://github.com/chakra-ui/ark/blob/main/CONTRIBUTING.md) for more
information on how to contribute.

## License

This project is licensed under the terms of the [MIT license](https://github.com/chakra-ui/ark/blob/main/LICENSE).
This project is licensed under the terms of the
[MIT license](https://github.com/chakra-ui/ark/blob/main/LICENSE).
5 changes: 3 additions & 2 deletions packages/anatomy/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ description: All notable changes will be documented in this file.

### Fixed

- Resolved an issue where the `package.json` is missing export specifiers.
- Resolved an issue where the `package.json` is missing export specifiers.

## [2.3.0] - 2024-02-27

Expand Down Expand Up @@ -51,7 +51,8 @@ description: All notable changes will be documented in this file.

### Changed

- **Breaking Change**: Renamed the `indicator` part to `view` in the `Progress` component to more accurately reflect its functionality.
- **Breaking Change**: Renamed the `indicator` part to `view` in the `Progress` component to more
accurately reflect its functionality.

## [1.3.0] - 2024-01-17

Expand Down
Loading

0 comments on commit c907e94

Please sign in to comment.