Skip to content

Commit e7d92f3

Browse files
RichardLittsglyon
authored andcommitted
Developer Experience Audit (#30)
* Adding Code of Conduct * Adding 2017 * Standardizing README Adding a contribute and license section, too.
1 parent f5e9cff commit e7d92f3

File tree

3 files changed

+93
-7
lines changed

3 files changed

+93
-7
lines changed

CODE_OF_CONDUCT.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Covenant 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, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
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 [email protected]. 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 [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

LICENSE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
The Plotly.jl package is licensed under the MIT "Expat" License:
22

3-
> Copyright (c) 2016:
3+
> Copyright (c) 2016-2017:
44
> * Shilei Zheng
55
> * Leah Hanson
66
> * Bryan A. Knowles
7-
> * chriddyp
7+
> * Chris Palmer
88
> * Jon Malmaud
99
1010
> Permission is hereby granted, free of charge, to any person obtaining

README.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
# A Julia interface to the plot.ly plotting library and cloud services
1+
# Plotly.jl
22

33
[![Build Status](https://travis-ci.org/plotly/Plotly.jl.svg)](https://travis-ci.org/plotly/Plotly.jl)
44

5-
## Installation
5+
> A Julia interface to the plot.ly plotting library and cloud services
6+
7+
## Install
68

79
Simply run `Pkg.add("Plotly")`.
810

9-
## Plotting
11+
## Usage
1012

1113
Plotting functions provided by this package are identical to [PlotlyJS](https://github.com/spencerlyon2/PlotlyJS.jl). Please consult its [documentation](http://spencerlyon.com/PlotlyJS.jl/).
1214

@@ -27,7 +29,7 @@ julia> Plotly.signin("username","your api key")
2729
PlotlyAccount("username","your api key")
2830
```
2931

30-
Note: you may also specify your session endpoints using signin as follows:
32+
Note: you may also specify your session endpoints using sign in as follows:
3133

3234
```julia
3335
julia> Plotly.signin("username","your api key",Dict("plotly_domain"=> "your_plotly_base_endpoint", "plotly_api_domain"=> "your_plotly_api_endpoint"))
@@ -68,8 +70,18 @@ local_plot = download(RemotePlot("https://plot.ly/~malmaud/73"))
6870
# or equivalently, local_plot = download_plot("https://plot.ly/~malmaud/73")
6971
```
7072

73+
## Acknowledgements
7174

72-
### Acknowledgements
7375
[PlotlyJS.jl ](https://github.com/spencerlyon2/PlotlyJS.jl), which provides the large majority of the functionality of this package, is developed primarily by Spencer Lyon.
7476

7577
This package, which adds to PlotlyJS.jl the functionality for interacting with the Plotly cloud, is developed by Jon Malmaud and others.
78+
79+
## Contribute
80+
81+
Please do! This is an open source project. Check out [the issues](https://github.com/plotly/Plotly.jl/issues) or open a PR!
82+
83+
We want to encourage a warm, welcoming, and safe environment for contributing to this project. See the [code of conduct](CODE_OF_CONDUCT.md) for more information.
84+
85+
## License
86+
87+
[MIT](LICENSE.md) © 2016-2017 Shilei Zheng, Leah Hanson, Bryan A. Knowles, Chris Palmer, Jon Malmaud

0 commit comments

Comments
 (0)