Skip to content

Latest commit

 

History

History
47 lines (29 loc) · 2.15 KB

contributing.md

File metadata and controls

47 lines (29 loc) · 2.15 KB

Getting started

Getting started with Git and GitHub

Once you're familiar with Git and GitHub, clone the repository. The requirements are Visual Studio 2017 and .net Core 1.0.3.

Discussing ideas

The functionality is based as much as possible on existing functionality in Liquid

We prefer if 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 file if you use an editor or plugin respecting it.

Getting PRs merged

  • Describe in your message, what you're fixing. Reference the original issue, if possible.
  • Describe how if any API-breaking changes your PR may introduce.
  • State whether it's ready-to-review/-merge or if it's a WIP PR.

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 after the PR is submitted

Publishing a new release

New release happens automatically upon merge to master thanks to the AppVeyor job. At the top of the main [Readme] (https://github.com/dotliquid/dotliquid/blob/master/README.markdown) there is a link icon to AppVeyor showing the status of the last build.

Documentation

The docs sources are here. Don't hesitates to add some docs on existing features, or to write a new for your PR.