Skip to content

Commit

Permalink
Configure AppVeyor to run markdown linter
Browse files Browse the repository at this point in the history
Now all Markdown files in the project will be validated on build.

Closes #65
  • Loading branch information
baynezy committed Sep 23, 2017
1 parent 1cf4cbd commit 9192ab5
Show file tree
Hide file tree
Showing 4 changed files with 72 additions and 14 deletions.
44 changes: 35 additions & 9 deletions CODE_OF_CONDUCT.md
Expand Up @@ -2,7 +2,12 @@

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of
experience, nationality, personal appearance, race, religion, or sexual identity
and orientation.

## Our Standards

Expand All @@ -19,28 +24,49 @@ 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
* 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 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.
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 both within project spaces and in public spaces when an individual is representing the project or its community. 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.
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. 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 simon@bayn.es. The project team will review and investigate all complaints, and will respond in a way that it deems 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.
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at simon@bayn.es. The project team will
review and investigate all complaints, and will respond in a way that it deems
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.
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 [http://contributor-covenant.org/version/1/4][version]
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 1.4, available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
34 changes: 31 additions & 3 deletions CONTRIBUTING.md
Expand Up @@ -2,12 +2,40 @@

## Pull Requests

After forking the repository please create a pull request before creating the fix. This way we can talk about how the fix will be implemeted. This will greatly increase your chance of your patch getting merged into the code base.
After forking the repository please create a pull request before creating the
fix. This way we can talk about how the fix will be implemeted. This will
greatly increase your chance of your patch getting merged into the code base.

Please create all pull requests from the `develop` branch.

### AppVeyor

[AppVeyor](https://www.appveyor.com/) is a Continous Delivery system for this
project. It is configured in `appveyor.yml`. All PRs and commits to the project
are checked on AppVeyor. You can setup AppVeyor for your own fork which means
you can test your code prior to raising a PR.

### Commit Template

Please run the following to make sure you commit messages conform to the project standards.
Please run the following to make sure you commit messages conform to the project
standards.

```bash
git config --local commit.template .gitmessage
```

## Markdown

There are linting rules for the markdown documentation in this project. So
please adhere to them. This can be achieved by installing the node module
`markdownlint-cli`.

```bash
npm install -g markdownlint-cli
```

Then to check your Markdown run.

git config --local commit.template .gitmessage
```bash
markdownlint .
```
4 changes: 2 additions & 2 deletions PULL_REQUEST_TEMPLATE.md
@@ -1,5 +1,5 @@
# Pull Request

## Please add description for changes you are making.
## Please add description for changes you are making

## If there is an issue related to this PR, please add the reference.
## If there is an issue related to this PR, please add the reference
4 changes: 4 additions & 0 deletions appveyor.yml
Expand Up @@ -3,6 +3,8 @@ skip_tags: true
configuration: Release
init:
- git config --global core.autocrlf true
install:
- ps: npm install -g markdownlint-cli
build:
publish_nuget: true
verbosity: minimal
Expand All @@ -22,6 +24,8 @@ build_script:
- cmd: >-
cd %BUILD_DIR%
markdownlint .
dotnet restore
dotnet build
Expand Down

0 comments on commit 9192ab5

Please sign in to comment.