Skip to content

Commit 6951e8f

Browse files
SaraVieiraCompuIves
authored andcommitted
add CODE_OF_CONDUCT (codesandbox#1223)
1 parent be80aee commit 6951e8f

File tree

2 files changed

+99
-17
lines changed

2 files changed

+99
-17
lines changed

CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# CodeSandbox Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
- Using welcoming and inclusive language
18+
- Being respectful of differing viewpoints and experiences
19+
- Gracefully accepting constructive criticism
20+
- Focusing on what is best for the community
21+
- Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
- The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
- Trolling, insulting/derogatory comments, and personal or political attacks
28+
- Public or private harassment
29+
- Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
- Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

CONTRIBUTING.md

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,15 @@
22

33
## Table of Contents
44

5-
* [Code Organization](#code-organization)
6-
* [Setting Up the project locally](#setting-up-the-project-locally)
7-
* [Submitting a Pull Request](#submitting-a-pull-request)
8-
* [Add yourself as a contributor](#add-yourself-as-a-contributor)
5+
- [Code of Conduct](#code-of-conduct)
6+
- [Code Organization](#code-organization)
7+
- [Setting Up the project locally](#setting-up-the-project-locally)
8+
- [Submitting a Pull Request](#submitting-a-pull-request)
9+
- [Add yourself as a contributor](#add-yourself-as-a-contributor)
10+
11+
## Code of Conduct
12+
13+
We have a code of conduct you can find [here](https://github.com/CompuIves/codesandbox-client/blob/master/CODE_OF_CONDUCT.md) and every contributor is expect to obey the rules on it. Any issues or PR may be closes if not in terms with it.
914

1015
## Code Organization
1116

@@ -19,26 +24,27 @@ The CodeSandbox client is currently divided in to 5 parts. We use `lerna` to sha
1924

2025
This version of CodeSandbox is using the production server as source of truth, this is specified by the environment variable `LOCAL_SERVER`. If you're working on a feature that needs you to be logged in, you can login on [https://codesandbox.io/](https://codesandbox.io/) and copy the contents of the `jwt` local storage key over to your development environment on [http://localhost:3000/](http://localhost:3000/). **Be very careful with how you handle the token**, as anyone who knows it can login as you and have read/write access to all your CodeSandbox content!
2126

22-
**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
27+
**Working on your first Pull Request?** You can learn how from this _free_ series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
2328

2429
## Setting Up the project locally
2530

2631
To install the project you need to have `yarn` and `node`
2732

28-
1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your fork:
33+
1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your fork:
34+
35+
```
36+
# Clone your fork
37+
git clone https://github.com/<your-username>/codesandbox-client.git
2938
30-
```
31-
# Clone your fork
32-
git clone https://github.com/<your-username>/codesandbox-client.git
39+
# Navigate to the newly cloned directory
40+
cd codesandbox-client
41+
```
3342
34-
# Navigate to the newly cloned directory
35-
cd codesandbox-client
36-
```
37-
2. `yarn` to install dependencies
38-
3. `yarn start` to start the app
39-
* this builds the dependencies (`codesandbox-api` and `codesandbox-browserfs`) and runs the `app` development environment, available on [http://localhost:3000/s/new](http://localhost:3000/s/new)
40-
* on subsequent runs you can also bypass dependencies building and use `yarn start:fast`
41-
* if you want to work on the homepage, start it with `yarn start:home`, it will be available on [http://localhost:8000/](http://localhost:8000/)
43+
2. `yarn` to install dependencies
44+
3. `yarn start` to start the app
45+
- this builds the dependencies (`codesandbox-api` and `codesandbox-browserfs`) and runs the `app` development environment, available on [http://localhost:3000/s/new](http://localhost:3000/s/new)
46+
- on subsequent runs you can also bypass dependencies building and use `yarn start:fast`
47+
- if you want to work on the homepage, start it with `yarn start:home`, it will be available on [http://localhost:8000/](http://localhost:8000/)
4248
4349
> Tip: Keep your `master` branch pointing at the original repository and make
4450
> pull requests from branches on your fork. To do this, run:

0 commit comments

Comments
 (0)