Skip to content

Commit

Permalink
🎈 First Pass
Browse files Browse the repository at this point in the history
  • Loading branch information
jeroenransijn committed Jul 30, 2017
1 parent 94cfd26 commit 4f1018f
Show file tree
Hide file tree
Showing 14 changed files with 461 additions and 66 deletions.
41 changes: 41 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# 🏳️‍🌈 Contributor Covenant Code of Conduct 🏳️‍🌈

## Our Pledge

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.

## 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 [email protected]. 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, version 1.4, available at http:https://contributor-covenant.org/version/1/4.
60 changes: 60 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# 🎉 Thanks for taking the time to contribute to 🌲Evergreen! 🎉

It is highly appreciated that you take the time to help improve 🌲Evergreen.

Please see our [ISSUE_TEMPLATE](./ISSUE_TEMPLATE.md) for issues specifically.

## Creating new components

Preferably we like to introduce new components by following these steps.

### Submit an issue

To better understand if your component is wanted by evergreen,
submit a component request first as an issue.
Explain why you want the component.
Potentially include a design or component api.

**Smaller atoms and primitives are favored over bigger complex components.**

### Design

This can be a wireframe or high fidelity mockup.
Include this in your issue if possible.

We hope to formalize the 🌲Evergreen design language more as we go.
As a general rule of thumb try to include the follow these constraints:

* Use `evergreen-color` and `evergreen-typography`
* 8px soft grid, (4px under 40px is also good)
* Don't force line heights on grid if it looks poorly

### Component API

* Use `evergreen-color` and `evergreen-typography`
* Write down how you would like to use this component.
* Write down the component api and prop types.
* Try to implement `ui-box` for you components.
* Try to make all different heights possible.
* Base the text style (font size) on the height

Include this in your issue if possible.

## Write the code and storybook

Use a scaffolding scripts to bootstrap your component:

```
$ yarn create-package:component ComponentName
```

Make sure to write stories to document your component.


## Submit a PR when you are ready

Finally submit a PR with your new feature or component.

## Celebrate! 🎉

We'll add you to the contributors section
43 changes: 43 additions & 0 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# 🎉 Thanks for taking the time to contribute to 🌲Evergreen! 🎉

It is highly appreciated that you take the time to help improve 🌲Evergreen.
We appreciate it if you would take the time to write up a bug report or feature request.

Sadly, if we don't receive enough information, or the issue/feature request doesn't
align well with our [ROADMAP.md](./ROADMAP.md), we might respectfully
thank you for your time, and close the issue.

*Bug fixes and documentation fixes are welcome.*

## In the case of a bug report 🐞

Please consider the following items when filing a bug report:

* Issue and Steps to Reproduce
* Versions
* Screenshots
* Expected
* Actual
* Link to your project
* Browser Name and version
* Operating system

## In the case of a feature/component request ✍️

Please consider the following items when filing a feature request:

* Example component API if applicable
* Problem that feature/component addresses
* Examples in other projects of feature/component
* Screenshots if design changes

## Respect earns Respect 👏

Please respect our [CODE_OF_CONDUCT](./CODE_OF_CONDUCT.md), in short:

* 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:
21 changes: 0 additions & 21 deletions LICENSE

This file was deleted.

22 changes: 22 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## License (MIT)

```
WWWWWW||WWWWWW
W W W||W W W
||
( OO )__________
/ | \
/o o| MIT \
\___/||_||__||_|| *
|| || || ||
_||_|| _||_||
(__|__|(__|__|
```

Copyright (c) 2017 Segment.io, Inc. <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
19 changes: 19 additions & 0 deletions PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# 🎉 Thanks for taking the time to contribute to 🌲Evergreen! 🎉

It is highly appreciated that you take the time to help improve Evergreen.
We appreciate it if you would take the time to document your Pull Request.

Sadly, if we don't receive enough information, or the Pull Request doesn't
align well with our [ROADMAP.md](./ROADMAP.md), we might respectfully
thank you for your time, and close the issue.

## Respect earns Respect 👏

Please respect our [CODE_OF_CONDUCT](./CODE_OF_CONDUCT.md), in short:

* 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:
Loading

0 comments on commit 4f1018f

Please sign in to comment.