Skip to content

Commit

Permalink
Add contributing info and issue template (dotliquid#246) [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
Jérémie Bertrand authored Jun 18, 2017
1 parent a3975d0 commit e9e3735
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
31 changes: 31 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## Getting started

**Getting started with Git and GitHub**

* [Setting up Git for Windows and connecting to GitHub](http://help.github.com/win-set-up-git/)
* [Forking a GitHub repository](http://help.github.com/fork-a-repo/)
* [The simple guide to GIT guide](http://rogerdudler.github.com/git-guide/)

Once you're familiar with Git and GitHub, clone the repository.
The requirements are [Visual Studio 2017](https://www.visualstudio.com/) and [.net Core 1.0.3](https://www.microsoft.com/net/download/core#/sdk).

## Discussing ideas

* [Gitter Chatroom](https://gitter.im/dotliquid/dotliquid)
* [GitHub Issues](https://github.com/dotliquid/dotliquid/issues/new)

**The functionality is based as much as possible on existing functionality in [Liquid](https://shopify.github.io/liquid/)**

Each new feature must have been discussed first before submitting it in a PR.

## Coding conventions

We prefer spaces over tabs for indentation.
We have an [editorconfig](http://EditorConfig.org) [file](./.editorconfig) if you use an editor or plugin respecting it.

## Testing

Tests are mandatory for new functionality, please add some in the tests suite.
You can see the result either:
- in Visual Studio or other IDE supporting NUnit 3
- on [AppVeyor](https://ci.appveyor.com/project/tgjones/dotliquid) after the PR is submitted
7 changes: 7 additions & 0 deletions issue_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
### Dotliquid version

### Expected behavior

### Actual behavior

### Steps to reproduce the Problem (you can add files)

0 comments on commit e9e3735

Please sign in to comment.