Skip to content

Commit

Permalink
Update contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
webpro committed Dec 19, 2018
1 parent 17edd60 commit 24038ce
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 28 deletions.
59 changes: 32 additions & 27 deletions CONTRIBUTING.md
Expand Up @@ -6,48 +6,49 @@ This project has a [Contributor Covenant Code of Conduct](./CODE_OF_CONDUCT.md).

## ❤️ Ways to Contribute

* Blog or tweet about the project
* Improve documentation
* Fix a bug
* Implement a new feature
* Discuss potential ways to improve project
* Improve existing implementation, performance, etc.
- Blog or tweet about the project
- Improve documentation
- Fix a bug
- Implement a new feature
- Discuss potential ways to improve project
- Improve existing implementation, performance, etc.

## 🛎 Questions
## 🛎 Questions & Feature Requests

Feel free to open a ticket with your question.

Please put some effort in requesting a new feature. If someone else is going to implement something, the least you can do is describe the feature in detail, and why it would be useful to others as well.
Feel free to [open a ticket](https://github.com/webpro/release-it/issues/new) with your question. Feature requests are also welcome. Describe the feature, why you need it, and how it should work. Please provide as much detail and context as possible.

## 🐛 File a Bug

In case you've encountered a bug, please make sure:

* You are using the [latest version](https://github.com/webpro/release-it/releases).
* You have read the [documentation](https://github.com/webpro/release-it/blob/master/README.md) first, and double-checked your configuration.
* You have acknowledged from `--verbose` and `--debug` the errors are likely a bug in this project (and not coming from your environment or a dependency of this project).
* In your issue description, please include:
* What you expected to see, and what happened instead.
* Your operating system and other environment information.
* As much information as possible, such as the command and configuration used.
* Interesting logs with `--verbose` and/or `--debug`.
* All steps to reproduce the issue.
- You are using the [latest version](https://github.com/webpro/release-it/releases).
- You have read the [documentation](https://github.com/webpro/release-it/blob/master/README.md) first, and double-checked your configuration.
- You have acknowledged from using `--verbose` and `--debug` the errors are likely a bug in this project, and not coming from e.g. your environment or custom scripts/commands.
- In your issue description, please include:
_ What you expected to see, and what happened instead.
_ Your operating system and other environment information.
_ As much information as possible, such as the command and configuration used.
_ Interesting logs with `--verbose` and/or `--debug`. \* All steps to reproduce the issue.

## 🎁 Pull Requests

Pull requests are welcome! Please keep the following in mind:
Pull requests are welcome! If you never created a pull request before, here are some tutorials:

- [Creating a pull request](https://help.github.com/articles/creating-a-pull-request/)
- [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)

* See below for instructions on how to set up the project on your machine.
* To match the existing code styling, use `npm run prettier` before committing code.
* Make sure the tests pass (run `npm test`). Your changes probably deserve new tests as well.
* Remember that this project is cross-platform compatible (macOS, Windows, Linux), and that it runs in different versions of Node.
Please keep the following in mind:

- To match the existing code styling, use `npm run format` before committing code.
- Make sure the tests pass (run `npm test`). Your changes probably deserve new tests as well.
- Remember that this project is cross-platform compatible (macOS, Windows, Linux), and that it runs in different versions of Node.

Unsure about whether you should open a pull request? Feel free to discuss it first in a ticket.

Set up the project on your machine:
[Fork](https://help.github.com/articles/fork-a-repo/) the repository, and set it up on your machine:

```bash
git clone https://github.com/webpro/release-it
git clone https://github.com/<your-github-username>/release-it
cd release-it
npm install
```
Expand All @@ -58,8 +59,12 @@ Verify the tests are passing:
npm test
```

To make release-it globally available so you can run it on your (test) project:
To use your modified version of release-it in your project, [npm-link](https://docs.npmjs.com/cli/link.html) it:

```
# From your release-it clone:
npm link
# From your project that uses release-it:
npm link release-it
```
4 changes: 3 additions & 1 deletion README.md
Expand Up @@ -21,7 +21,9 @@ CLI release tool for Git repos and npm packages.
[![npm version](https://badge.fury.io/js/release-it.svg)](https://badge.fury.io/js/release-it)
[![Greenkeeper badge](https://badges.greenkeeper.io/webpro/release-it.svg)](https://greenkeeper.io/)

_See [CHANGELOG.md](CHANGELOG.md) for major updates and breaking changes; the [releases](https://github.com/webpro/release-it/releases) section for a detailed version history._
_See [CHANGELOG.md](CHANGELOG.md) for major updates and breaking changes.
Refer to the [releases](https://github.com/webpro/release-it/releases) section for a detailed version history.
Want to help out, or hack on release-it? Great! Please read [CONTRIBUTING.md](CONTRIBUTING.md) on how to participate._

<details>
<summary><strong>Table of Contents</strong> (click to expand)</summary>
Expand Down

0 comments on commit 24038ce

Please sign in to comment.