Skip to content

Commit e0db967

Browse files
committed
Fixed #4 -- added community and conduct language to docs.
1 parent 013ea3a commit e0db967

3 files changed

Lines changed: 73 additions & 16 deletions

File tree

docs/contributing/community.rst

Lines changed: 50 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,62 @@
77
Community
88
=========
99

10+
Deis is a fully open source project. As such, the "Deis community" consists
11+
of anyone who uses the Deis software and participates in its evolution,
12+
whether by answering questions, finding bugs, suggesting enhancements, or
13+
writing documentation or code.
14+
15+
Deis development is coordinated through its project `on GitHub`_. Anyone can
16+
check out the source code for Deis, fork the project, make improvements,
17+
and create a pull request to incorporate those changes into Deis.
18+
19+
`OpDemand`_ maintains the Deis project, and as such has final say over what
20+
ends up in the official GitHub repository for Deis. Deis depends on the
21+
contributions of the community; the maintainers will not ignore pull
22+
requests or issues.
1023

1124
Conduct
1225
=======
1326

14-
The deis community welcomes and encourages participation by everyone.
27+
The deis community welcomes and encourages participation by **everyone**.
1528

1629
No matter how you identify yourself or how others perceive you: we welcome
1730
you. We welcome contributions from everyone as long as they interact
1831
constructively with our community.
1932

20-
While much of the work for our project is technical in nature, we value and
21-
encourage contributions from those with expertise in other areas, and welcome
22-
them into our community.
33+
The deis developer community continues to grow, and it is inevitable that
34+
disagreements and conflict will arise. We ask that participants conduct
35+
themselves according to these principles:
36+
37+
- **Be welcoming, friendly, and patient.**
38+
39+
- **Be considerate.**
40+
41+
Your work will be used by other people, and you in turn will depend on
42+
the work of others. Any decision you take will affect users and
43+
colleagues, and you should take those consequences into account when
44+
making decisions. Remember that we're a world-wide community, so you
45+
might not be communicating in someone else's primary language.
46+
47+
- **Be respectful.**
48+
49+
Not all of us will agree all the time, but disagreement is no excuse
50+
for poor behavior and bad manners. We might all experience some
51+
frustration now and then, but we cannot allow that frustration to turn
52+
into a personal attack. It’s important to remember that a community
53+
where people feel uncomfortable or threatened is not a productive one.
54+
55+
- **Be careful in the words that you choose.**
56+
57+
Be kind to others. Do not insult or put down other participants.
58+
Behave professionally. Remember that harassment and sexist, racist, or
59+
exclusionary jokes are never appropriate for the community.
60+
61+
(Thanks to the `Debian`_ and `Django`_ communities for their text and
62+
their inspiration.)
63+
64+
.. _`on Github`: https://github.com/opdemand/deis
65+
.. _`OpDemand`: http://www.opdemand.com/
66+
.. _`Debian`: http://www.debian.org/intro/diversity
67+
.. _`Django`: https://www.djangoproject.com/conduct/
68+

docs/contributing/developer.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,9 @@
77
Developer Setup
88
===============
99

10+
**Coming soon...**
11+
12+
Coding Standards
13+
================
14+
15+
**Coming soon...**

docs/contributing/index.rst

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,39 +7,44 @@
77
Contributing
88
============
99

10-
How Can I Help?
11-
---------------
12-
1310
File Bugs & Enhancements
14-
~~~~~~~~~~~~~~~~~~~~~~~~
11+
------------------------
1512
Find a bug? Want to see a new feature? Have a request
16-
for the maintainers? Open a GitHub issue and we’ll get the conversation
13+
for the maintainers? Open a `GitHub issue`_ and we’ll get the conversation
1714
started.
1815

1916
Write Documentation
20-
~~~~~~~~~~~~~~~~~~~
17+
-------------------
2118
We are always looking to improve and expand our
22-
documentation. Most docs reside in the main repository under the docs/
19+
documentation. Most docs reside in the main repository under the `docs/`_
2320
directory. Simply fork the project, update docs and send us a pull request.
2421

2522
Enhance Chef Integration
26-
~~~~~~~~~~~~~~~~~~~~~~~~
23+
------------------------
2724
We want Chef users to feel at home using Deis. Got an
2825
idea for improving our Chef integration? Have some thoughts on making the
29-
deis-cookbook more reusable? Open a GitHub issue and let us know!
26+
`deis-cookbook`_ more reusable? Open a `GitHub issue`_ and let us know!
3027

3128
Add New Cloud Providers
32-
~~~~~~~~~~~~~~~~~~~~~~~
29+
-----------------------
3330
Want to see Deis extended to a new cloud provider? Go
34-
for it! Adding new providers is easy. Just follow the EC2 example and make
31+
for it! Adding new providers is easy. Just follow the `EC2 example`_ and make
3532
sure you provide test coverage in your pull request.
3633

3734
Improve Deis Core
38-
~~~~~~~~~~~~~~~~~
35+
-----------------
3936
Deis core is a Django/Celery application with a Python CLI.
4037
We are always looking for help improving the core framework, tooling and test
4138
coverage. Interested in contributing to Deis core? Let’s chat in IRC.
4239

40+
.. _`Github issue`: https://github.com/opdemand/deis/issues/new
41+
.. _`docs/`: https://github.com/opdemand/deis/tree/master/docs
42+
.. _`deis-cookbook`: https://github.com/opdemand/deis-cookbook
43+
.. _`EC2 Example`: https://github.com/opdemand/deis/blob/master/celerytasks/ec2.py
44+
45+
See Also
46+
--------
47+
4348
.. toctree::
4449
:maxdepth: 1
4550

0 commit comments

Comments
 (0)