Skip to content

Commit

Permalink
File changes (#11)
Browse files Browse the repository at this point in the history
  • Loading branch information
mym0404 committed Mar 14, 2024
2 parents 6dced0d + 7232352 commit 6e5f456
Show file tree
Hide file tree
Showing 6 changed files with 201 additions and 14 deletions.
78 changes: 78 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# 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, 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:

- 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, 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 project 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 project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at **mym0404@gmail.com**. 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. Further details of specific enforcement policies may be posted
separately.

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
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

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

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
117 changes: 117 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
Thanks for showing interest to contribute to React Native Styled System 💖, you rock!

When it comes to open source, there are different ways you can contribute, all
of which are valuable. Here's a few guidelines that should help you as you
prepare your contribution.

## Setup the Project

The following steps will get you up and running to contribute to Chakra UI:

1. Fork the repo (click the <kbd>Fork</kbd> button at the top right of
[this page](https://github.com/mj-studio-library/react-native-styled-system))

2. Clone your fork locally

3. Setup all the dependencies and packages by running `yarn install`. This
command will install dependencies.

## Development

### Commands

**`yarn install`**: bootstraps the entire project, symlinks all dependencies.

**`yarn build`**: Run static checks & build with `react-native-builder-bob`

**`yarn lint`**: Check ESLint

**`yarn check:type`**: Check typescript without noEmit

**`yarn test`**: Run test with jest

## Think you found a bug?

Please conform to the issue template and provide a clear path to reproduction
with a code example. The best way to show a bug is by sending a CodeSandbox
link.

## Proposing new or changed API?

Please provide thoughtful comments and some sample API code. Proposals that
don't line up with our roadmap or don't have a thoughtful explanation will be
closed.

## Making a Pull Request?

Pull requests need only the :+1: of two or more collaborators to be merged; when
the PR author is a collaborator, that counts as one.

### Commit Convention

Before you create a Pull Request, please check whether your commits comply with
the commit conventions used in this repository.

Rules through commitlint are applied, and correct commit messages can be created with git cz through commitizen.

- [commitlint](https://commitlint.js.org/)
- [commitizen cz-cli](https://github.com/commitizen/cz-cli)

When you create a commit we kindly ask you to follow the convention
`category(scope or module, optional): message` in your commit message while using one of
the following categories:

- `feat / feature`: all changes that introduce completely new code or new
features
- `fix`: changes that fix a bug (ideally you will additionally reference an
issue if present)
- `refactor`: any code related change that is not a fix nor a feature
- `docs`: changing existing or creating new documentation (i.e. README, docs for
usage of a lib or cli usage)
- `build`: all changes regarding the build of the software, changes to
dependencies or the addition of new dependencies
- `test`: all changes regarding tests (adding new tests or changing existing
ones)
- `ci`: all changes regarding the configuration of continuous integration (i.e.
github actions, ci system)
- `chore`: all changes to the repository that do not fit into any of the above
categories

If you are interested in the detailed specification you can visit
https://www.conventionalcommits.org/ or check out the
[Angular Commit Message Guidelines](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines).

### Steps to PR

1. Fork of the this repository and clone your fork

2. Create a new branch out of the `main` or `develop` branch. We follow the convention
`[type/scope]`. For example `fix/accordion-hook` or `docs/menu-typo`. `type`
can be either `docs`, `fix`, `feat`, `build`, or any other conventional
commit type. `scope` is just a short id that describes the scope of work.

3. Make and commit your changes following the
[commit convention](https://github.com/mj-studio-library/react-native-styled-system/blob/main/CONTRIBUTING.md#commit-convention).
As you develop, you can run `yarn t` and to make sure everything works as expected.

4. You should base branch of PR as `develop`.

### Tests

All commits that fix bugs or add features need a test.

## Want to write a blog post or tutorial

That would be amazing! Reach out to me (mym0404@gmail.com).

We would love to support you any way we can.

## Want to help improve the docs?

Our docsite lives in a `doc` directory in project. If you're
interested in contributing to the documentation, create pr as manual.

## License

By contributing your code to the chakra-ui GitHub repository, you agree to
license your contribution under the MIT license.
3 changes: 2 additions & 1 deletion doc/docs/usage/component.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ const ScreenErrorFallback = (props: Props) => {
return (
<View
//highlight-next-line
style={viewStyle({ alignItems: 'center', justifyContent: 'center' })}
style={viewStyle({ center: true })}
pointerEvents={'box-none'}
>
```
Expand All @@ -118,6 +118,7 @@ There is no need to add `style` as a prop to `style` of `View`.
2. Always pass all `props` objects themselves to `useSx` to avoid missing any properties. `useSx`
Properties that are not used internally are ignored and not changed.
3. `viewStyle` can receive `SxProps` as an argument and consider it in the result.
4. `center` is a shortcut for `justifyContent: center`, `alignItems: center`.

## Example without Props destruction

Expand Down
12 changes: 1 addition & 11 deletions doc/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,17 +43,7 @@ const config: Config = {
{
docs: {
sidebarPath: './sidebars.ts',
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
},
blog: {
showReadingTime: true,
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
editUrl: `${repoUrl}/tree/main/doc/`,
},
theme: {
customCss: './src/css/custom.css',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ const ScreenErrorFallback = (props: Props) => {
return (
<View
// highlight-next-line
style={viewStyle({ alignItems: 'center', justifyContent: 'center' })}
style={viewStyle({ center: true })}
pointerEvents={'box-none'}
>
```
Expand All @@ -118,6 +118,7 @@ const ScreenErrorFallback = (props: Props) => {
2. 누락되는 속성이 없게 항상 모든 `props` 객체 자체를 `useSx`로 넘기도록 합니다. `useSx`는
내부적으로 쓰이지 않는 속성들은 무시하고 변경시키지 않습니다.
3. `viewStyle`은 `SxProps`를 인자로 받아 결과에 고려시킬 수 있습니다.
4. `center`는 `justifyContent: center`, `alignItems: center` 의 단축 속성입니다.

## Props destruction을 사용하지 않는 예시

Expand Down
2 changes: 1 addition & 1 deletion issue_template.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### Version of dooboo-hooks
### Version of react-native-themed-styled-system

### Version of react-native

Expand Down

0 comments on commit 6e5f456

Please sign in to comment.