Skip to content

Improve contributing #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 26, 2019
Merged

Improve contributing #38

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
57434f1
Update CONTRIBUTING.md
vbrazo Oct 26, 2019
2bf1cea
Update CONTRIBUTING.md
vbrazo Oct 26, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,18 @@
## Contributing

## General
Please ensure your pull request adheres to the following guidelines:

* New example or improvements to existing examples are welcome.
* Please check your spelling and grammar.

## Adding a New Example
To add a new example, create a new folder and a file or a file (depending upon the example) under the appropriate directory in `./examples`. Please check the `.plan` file to see what examples we plan to create. Feel free to work on any pending examples. We're happy to read/review your changes and collaborate/code with you to merge them.

Thank you for your contributions!

## Getting started with the project

#### 1. Fork and clone this repository

[Fork this repository](https://github.com/v-community/v_by_example/fork) and clone your fork. If you don't know what forking means or don't know how to do it, nice instructions are available [here](https://help.github.com/articles/fork-a-repo/).
Expand Down