Skip to content

Commit

Permalink
Add a contribution guide
Browse files Browse the repository at this point in the history
- Move the current contribution info from the README into the guide
- Add a Code of Conduct
- Add a CONTRIBUTING.md file to the root of the repo that points to the website
- Add the contribution guide to the Guides dropdown & page
- Add the presentations list from https://github.com/bitovi/bitovi/blob/master/great-technology/evangelism/presentations.md

Fixes #295
  • Loading branch information
chasenlehara committed Feb 14, 2017
1 parent f57df3a commit c4f2d9d
Show file tree
Hide file tree
Showing 9 changed files with 753 additions and 224 deletions.
74 changes: 74 additions & 0 deletions CODE_OF_CONDUCT.md
@@ -0,0 +1,74 @@
# 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 contact@bitovi.com. 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][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
31 changes: 31 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,31 @@
# Contributing to DoneJS

Check out the [contribution guide on DoneJS.com](https://donejs.com/contributing.html) for information on:

- [Code of Conduct](https://donejs.com/contributing.html#section=section_CodeofConduct)
- [Getting Help](https://donejs.com/contributing.html#section=section_GettingHelp)
- [Project Organization](https://donejs.com/contributing.html#section=section_ProjectOrganization)
- [Reporting Bugs](https://donejs.com/contributing.html#section=section_ReportingBugs)
- [Suggesting Features](https://donejs.com/contributing.html#section=section_SuggestingFeatures)
- [Finding Ways to Contribute](https://donejs.com/contributing.html#section=section_FindingWaystoContribute)
- [Finding open issues](#section=section_Findingopenissues)
- [Getting involved in the community](#section=section_Gettinginvolvedinthecommunity)
- [Spreading the word](#section=section_Spreadingtheword)
- [Developing Locally](https://donejs.com/contributing.html#section=section_DevelopingLocally)
- [Signing up for GitHub](https://donejs.com/contributing.html#section=section_SigningupforGitHub)
- [Forking & cloning the repository](https://donejs.com/contributing.html#section=section_Forking_cloningtherepository)
- [Installing the dependencies](https://donejs.com/contributing.html#section=section_Installingthedependencies)
- [Running the tests](https://donejs.com/contributing.html#section=section_Runningthetests)
- [Building the documentation](https://donejs.com/contributing.html#section=section_Buildingthedocumentation)
- [Viewing the site](https://donejs.com/contributing.html#section=section_Viewingthesite)
- [Changing the Code](https://donejs.com/contributing.html#section=section_ChangingtheCode)
- [Creating a new branch](https://donejs.com/contributing.html#section=section_Creatinganewbranch)
- [Style guide](https://donejs.com/contributing.html#section=section_Styleguide)
- [Updating the tests](https://donejs.com/contributing.html#section=section_Updatingtests)
- [Updating the documentation](https://donejs.com/contributing.html#section=section_Updatingthedocumentation)
- [Submitting a pull request](https://donejs.com/contributing.html#section=section_Submittingapullrequest)
- [Updating DoneJS.com](https://donejs.com/contributing.html#section=section_UpdatingDoneJS_com)
- [Evangelism](https://donejs.com/contributing.html#section=section_Evangelism)
- [Writing a blog article](https://donejs.com/contributing.html#section=section_Writingablogarticle)
- [Speaking at a conference or meetup](https://donejs.com/contributing.html#section=section_Speakingataconferenceormeetup)
- [Organizing a DoneJS meetup](https://donejs.com/contributing.html#section=section_OrganizingaDoneJSmeetup)
46 changes: 1 addition & 45 deletions README.md
Expand Up @@ -34,48 +34,4 @@ and [guides](https://donejs.com/Guides.html) on how to use them together to buil

## Contributing

### Cloning the repository

```
git clone git@github.com:donejs/donejs.git
cd donejs
```

### Installing the dependencies

```
npm install
```

### Running the tests

```
npm test
```

### Building the docs

```
npm run document
```

### Deploying to DoneJS.com

After cloning the repo and installing the dependencies:

```
git clone git@github.com:donejs/donejs.git -b gh-pages site/
```

If you get an error saying `Permission denied (publickey)` then you should follow GitHub’s instructions on
[generating an SSH key](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/).

Push a new commit to the `gh-pages` branch with the built docs:

```
npm run document
cd site/
git add --all
git commit -am "Updating site"
git push origin gh-pages
```
Check out the [contribution guide on DoneJS.com](https://donejs.com/contributing.html).
178 changes: 0 additions & 178 deletions docs/contribute.md

This file was deleted.

0 comments on commit c4f2d9d

Please sign in to comment.