Skip to content

Commit

Permalink
docs: Added codeOfConduct and Contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Oleksandr Shevtsov committed Sep 19, 2019
1 parent 9712e97 commit 122080f
Show file tree
Hide file tree
Showing 3 changed files with 225 additions and 0 deletions.
77 changes: 77 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, 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 within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
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 [INSERT EMAIL ADDRESS]. 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq

131 changes: 131 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
# Contributing to vscode-cy-helper

Firstly, thanks for considering contributing to *vscode-cy-helper*. To make it a really
great tool we need your help.

*vscode-cy-helper* is [Apache 2.0 licenced](LICENSE) and accepts contributions via GitHub
pull requests. There are many ways to contribute, from writing tutorials or blog posts,
improving the documentation, submitting bug reports and feature requests or writing code.


## Certificate of Origin

By contributing to this project you agree to the [Developer Certificate of
Origin](https://developercertificate.org/). This was created by the Linux
Foundation and is a simple statement that you, as a contributor, have the legal
right to make the contribution.

To signify that you agree to the DCO you must signoff all commits:

```bash
git commit --signoff
```

## Getting Started

- Fork the repository on GitHub
- Read the [README](README.md) for getting started as a user and learn how/where to ask for help
- If you want to contribute as a developer, continue reading this document for further instructions
- Play with the project, submit bugs, submit pull requests!

### Contribution workflow

#### 1. Set up your environment
1. You'll need the following tools:

- [Git](https://git-scm.com/)
- [Node.JS](https://nodejs.org/en/), x64, version >= 10.16.0, < 11.0.0
- [Yarn](https://yarnpkg.com/en/), follow the [installation guide](https://yarnpkg.com/en/docs/install)
- [Visual Studio Code](https://code.visualstudio.com/), version >= 1.38.0
- [VSCode Eslint Extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)

2. Fork this repository and clone it by running:

```bash
git clone [email protected]:<yourusername>/vscode-cy-helper.git
```

3. Install dependencies:

```bash
cd vscode-cy-helper
yarn install
```

#### 2. Test

Make sure you can run the tests.

```bash
yarn test
```

#### 3. Find a feature to work on

- Look at the existing [issues](https://github.com/90poe/vscode-cy-helper/issues) to see if there is anything
you would like to work on. If don't see anything then feel free to create your own feature request.

- If you are a new contributor then take a look at the issues marked
with [good first issue](https://github.com/90poe/vscode-cy-helper/labels/good%20first%20issue).

- Make your code changes within a feature branch:

```bash
git checkout -b <feature-name>
```

- Add yourself to [humans.txt](humans.txt) if this is your first contribution.

- Try to commit changes in logical units with a commit message in this [format](#commit-message-format). Remember
to signoff your commits.

- Don't forget to update the docs if relevent. The [README](README.md) is where docs usually live.
- Make sure the tests pass and that there are no linting problems.
#### 4. Create a pull request
Push your changes to your fork and then create a pull request to origin. Where possible use the PR template.
You can mark a PR as wotk in progress by prefixing the title of your PR with `WIP: `.
### Commit Message Format
We would like to follow the **Conventional Commits** format for commit messsages. The full specification can be
read [here](https://www.conventionalcommits.org/en/v1.0.0-beta.3/). The format is:
```
<type>: <description>
[optional body]
[optional footer]
```
Where `<type>` is one of the following:
* `feat` - a new feature
* `fix` - a bug fix
* `chore` - changes to the build pocess, code generation or anything that doesn't match elsewhere
* `docs` - documentation only changes
* `style` - changes that don't affect the meaning of the code (i.e. code formatting)
* `refactor` - a change that doesn't fix a feature or bug
* `test` - changes to tests only.

The `body` should include details of what changed and why. If there is a breaking change then the `body` should start with the
following: `BREAKING CHANGE`.

The footer should include any related github issue numbers.

An example:

```text
feat: Added new command to run cypress
A new command has been added to run cypress. The
command will execute cypress for single spec file with option `--no-exit`
Fixes: #123
```

A tool like [Commitizen](https://github.com/commitizen/cz-cli) can be used to help with formatting commit messages.
17 changes: 17 additions & 0 deletions humans.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
____ ___ _ ____ ____ _____ ____ ____ _ _____ _ ____ _____ ____
/ _\\ \/// __\/ __\/ __// ___\/ ___\ / \ /|/ __// \ / __\/ __// __\
| / \ / | \/|| \/|| \ | \| \ | |_||| \ | | | \/|| \ | \/|
| \__ / / | __/| /| /_ \___ |\___ | | | ||| /_ | |_/\| __/| /_ | /
\____//_/ \_/ \_/\_\\____\\____/\____/ \_/ \|\____\\____/\_/ \____\\_/\_\


/* Humans */
oleksandr @Shelex maintainer

/* Organizations */
90poe https://www.openocean.studio/

/* Thanks */
Thanks to 90poe for giving birth to this project and allowing it to be open sourced.

Also, thanks to all contributors and users (assuming there are more) of connectctl.

0 comments on commit 122080f

Please sign in to comment.