Skip to content
This repository was archived by the owner on Jun 20, 2022. It is now read-only.

Commit 8d51dc0

Browse files
committed
docs: add code of conduct & contributing
1 parent 1a19f7c commit 8d51dc0

File tree

2 files changed

+128
-0
lines changed

2 files changed

+128
-0
lines changed

CODE_OF_CONDUCT.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
- Using welcoming and inclusive language
12+
- Being respectful of differing viewpoints and experiences
13+
- Gracefully accepting constructive criticism
14+
- Focusing on what is best for the community
15+
- Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
- Trolling, insulting/derogatory comments, and personal or political attacks
21+
- Public or private harassment
22+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
- Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
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.
28+
29+
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.
30+
31+
## Scope
32+
33+
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.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems 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.
38+
39+
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.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# How to Contribute
2+
3+
Smooth UI is a small project, it is widely used but has not a lot of contributors. We're still working out the kinks to make contributing to this project as easy and transparent as possible, but we're not quite there yet. Hopefully this document makes the process for contributing clear and answers some questions that you may have.
4+
5+
## [Code of Conduct](https://github.com/smooth-code/smooth-ui/blob/master/CODE_OF_CONDUCT.md)
6+
7+
We expect project participants to adhere to our Code of Conduct. Please read [the full text](https://github.com/smooth-code/smooth-ui/blob/master/CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
8+
9+
## Open Development
10+
11+
All work on Smooth UI happens directly on [GitHub](/). Both core team members and external contributors send pull requests which go through the same review process.
12+
13+
### Workflow and Pull Requests
14+
15+
_Before_ submitting a pull request, please make sure the following is done…
16+
17+
1. Fork the repo and create your branch from `master`. A guide on how to fork a repository: https://help.github.com/articles/fork-a-repo/
18+
19+
Open terminal (e.g. Terminal, iTerm, Git Bash or Git Shell) and type:
20+
21+
```sh-session
22+
$ git clone https://github.com/<your_username>/smooth-ui
23+
$ cd smooth-ui
24+
$ git checkout -b my_branch
25+
```
26+
27+
Note: Replace `<your_username>` with your GitHub username
28+
29+
2. Smooth UI uses [Yarn](https://code.fb.com/web/yarn-a-new-package-manager-for-javascript/) for running development scripts. If you haven't already done so, please [install yarn](https://yarnpkg.com/en/docs/install).
30+
31+
3. Run `yarn install`. On Windows: To install [Yarn](https://yarnpkg.com/en/docs/install#windows-tab) on Windows you may need to download either node.js or Chocolatey<br />
32+
33+
```sh
34+
yarn install
35+
```
36+
37+
To check your version of Yarn and ensure it's installed you can type:
38+
39+
```sh
40+
yarn --version
41+
```
42+
43+
4. If you've added code that should be tested, add tests. You can use watch mode that continuously transforms changed files to make your life easier.
44+
45+
```sh
46+
# build packages continuously
47+
yarn run build:watch
48+
# run docs
49+
yarn run dev
50+
```
51+
52+
5. If you've changed APIs, update the documentation.
53+
54+
6. Ensure the linting is good via `yarn lint`.
55+
56+
```sh-session
57+
$ yarn lint
58+
```
59+
60+
7. Ensure the test suite passes via `yarn test`.
61+
62+
```sh-session
63+
$ yarn test
64+
```
65+
66+
## Bugs
67+
68+
### Where to Find Known Issues
69+
70+
We will be using GitHub Issues for our public bugs. We will keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new issue, try to make sure your problem doesn't already exist.
71+
72+
### Reporting New Issues
73+
74+
The best way to get your bug fixed is to provide a reduced test case. Please provide a public repository with a runnable example.
75+
76+
## Code Conventions
77+
78+
Please follow the `.prettierrc` in the project.
79+
80+
## License
81+
82+
By contributing to SVGR, you agree that your contributions will be licensed under its MIT license.

0 commit comments

Comments
 (0)