Permalink
Browse files

fixed docs, added coc

Signed-off-by: Dominik Wilkowski <Hi@Dominik-Wilkowski.com>
  • Loading branch information...
dominikwilkowski committed Oct 17, 2017
1 parent 4932627 commit c851d22a010ecc7b3610152369b570b1116fe38c
Showing with 263 additions and 125 deletions.
  1. +93 −0 CODE_OF_CONDUCT.md
  2. +16 −13 CONTRIBUTING.md
  3. +116 −105 FAQ.md
  4. +36 −5 ISSUE_TEMPLATE.md
  5. +2 −2 README.md
View
@@ -0,0 +1,93 @@
# Code of Conduct
## 1. Purpose
A primary goal of the UI-Kit is to be inclusive to the largest number of contributors, with the most varied and diverse backgrounds possible. As such, we are
committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, ability, ethnicity, socioeconomic status,
and religion (or lack thereof).
This code of conduct outlines our expectations for all those who participate in our community, as well as the consequences for unacceptable behavior.
We invite all those who participate in the UI-Kit to help us create safe and positive experiences for everyone.
## 2. Open Source Citizenship
A supplemental goal of this Code of Conduct is to increase open source citizenship by encouraging participants to recognize and strengthen the relationships
between our actions and their effects on our community.
Communities mirror the societies in which they exist and positive action is essential to counteract the many forms of inequality and abuses of power that exist
in society.
If you see someone who is making an extra effort to ensure our community is welcoming, friendly, and encourages all participants to contribute to the fullest
extent, we want to know.
## 3. Expected Behavior
The following behaviors are expected and requested of all community members:
* Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community.
* Exercise consideration and respect in your speech and actions.
* Attempt collaboration before conflict.
* Refrain from demeaning, discriminatory, or harassing behavior and speech.
* Be mindful of your surroundings and of your fellow participants. Alert community leaders if you notice a dangerous situation, someone in distress, or
violations of this Code of Conduct, even if they seem inconsequential.
* Remember that community event venues may be shared with members of the public; please be respectful to all patrons of these locations.
## 4. Unacceptable Behavior
The following behaviors are considered harassment and are unacceptable within our community:
* Violence, threats of violence or violent language directed against another person.
* Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language.
* Posting or displaying sexually explicit or violent material.
* Posting or threatening to post other people’s personally identifying information ("doxing").
* Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
* Inappropriate photography or recording.
* Inappropriate physical contact. You should have someone’s consent before touching them.
* Unwelcome sexual attention. This includes, sexualized comments or jokes; inappropriate touching, groping, and unwelcomed sexual advances.
* Deliberate intimidation, stalking or following (online or in person).
* Advocating for, or encouraging, any of the above behavior.
* Sustained disruption of community events, including talks and presentations.
## 5. Consequences of Unacceptable Behavior
Unacceptable behavior from any community member, including sponsors and those with decision-making authority, will not be tolerated.
Anyone asked to stop unacceptable behavior is expected to comply immediately.
If a community member engages in unacceptable behavior, the community organizers may take any action they deem appropriate, up to and including a temporary ban
or permanent expulsion from the community without warning (and without refund in the case of a paid event).
## 6. Reporting Guidelines
If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community organizer as soon as possible via
guides@digital.gov.au.
Additionally, community organizers are available to help community members engage with local law enforcement or to otherwise help those experiencing
unacceptable behavior feel safe. In the context of in-person events, organizers will also provide escorts as desired by the person experiencing distress.
## 7. Addressing Grievances
If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify the UI-Kit team with a concise description of your
grievance. Your grievance will be handled in accordance with our existing governing policies.
## 8. Scope
We expect all community participants (contributors, paid or otherwise; sponsors; and other guests) to abide by this Code of Conduct in all community
venues–online and in-person–as well as in all one-on-one communications pertaining to community business.
This code of conduct and its related procedures also applies to unacceptable behavior occurring outside the scope of community activities when such behavior has
the potential to adversely affect the safety and well-being of community members.
## 9. Contact info
guides@digital.gov.au
## 10. License and attribution
This Code of Conduct is distributed under a [Creative Commons Attribution-ShareAlike license](http://creativecommons.org/licenses/by-sa/3.0/).
Portions of text derived from the [Django Code of Conduct](https://www.djangoproject.com/conduct/) and the [Geek Feminism Anti-Harassment
Policy](http://geekfeminism.wikia.com/wiki/Conference_anti-harassment/Policy).
Retrieved on November 22, 2016 from [http://citizencodeofconduct.org/](http://citizencodeofconduct.org/)
View
@@ -1,11 +1,12 @@
Contributing to UI-Kit
======================
Hi! Thank you for your interest in contributing to UI-Kit, we really appreciate it.
Hi there! Thank you for your interest in contributing to UI-Kit, we really appreciate it.
There are many ways to contribute – reporting bugs, fixing bugs, new module suggestions, submitting pull requests for enhancements to modules.
There are many ways to contribute – reporting bugs, fixing bugs, new module suggestions, submitting pull requests for enhancements to modules or even writing
documentation.
Wherever you are in government, and whatever your discipline is, you are invited to contribute.
Wherever you are, and whatever your discipline is, you are invited to contribute.
## Contents
@@ -17,13 +18,14 @@ Wherever you are in government, and whatever your discipline is, you are invited
----------------------------------------------------------------------------------------------------------------------------------------------------------------
## Reporting Bugs, Asking Questions, Sending Suggestions
## Reporting Bugs, asking Questions, sending Suggestions
Use search to see if the same bug, question or suggestion has already been raised.
Use the search in [issues](https://github.com/govau/uikit/issues) to see if the same bug, question or suggestion has already been raised.
If you're requesting a new module, prefix the title with "new module:".
If youre requesting a new module, prefix the title with `new module: `.
If you're filing a bug, specific steps to reproduce are helpful. Please reference the module that has the bug, along with what you expected to see and what happened instead.
If you’re filing a bug, specific steps to reproduce are helpful. Please reference the module that has the bug, along with what you expected to see and what
happened instead. For more infos look at our [issue template](./ISSUE_TEMPLATE.md).
**[⬆ back to top](#contents)**
@@ -35,21 +37,22 @@ If you're filing a bug, specific steps to reproduce are helpful. Please referenc
If you’d like to contribute code, first, you will need to run UI-Kit locally.
💡 Building the UI-Kit is only necessary if you want to contribute to it. If you want to use the modules in your own project, install them via npm as described in [How to use](#how-to-use).
💡 Building the UI-Kit is only necessary if you want to contribute to it. If you want to use the modules in your own project, install them via npm as described
in [How to use](./README.md#how-to-use).
To build this project you have to install [lerna](https://github.com/lerna/lerna) globally after cloning it via `yarn global add lerna` and run:
To build this project you have to install [lerna](https://github.com/lerna/lerna) globally after cloning it via `npm install -g lerna` and run:
```shell
yarn
yarn bootstrap
yarn build
npm install
npm run bootstrap
npm run build
```
To make changes to an existing module, cd into the folder and run the watch:
```shell
cd packages/body
yarn watch
npm run watch
```
To add a new module run the scaffolding helper:
Oops, something went wrong.

0 comments on commit c851d22

Please sign in to comment.