Skip to content
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

Jump to bottom

Further copyedit Sublime Text plugin README #239

Merged
merged 1 commit into from
Oct 19, 2015
Merged

Further copyedit Sublime Text plugin README #239

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 7 additions & 8 deletions plugins/sublime/SublimeLinter-contrib-proselint/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
SublimeLinter-contrib-proselint
================================

[![Build Status](https://travis-ci.org/SublimeLinter/SublimeLinter-contrib-proselint.svg?branch=master)](https://travis-ci.org/SublimeLinter/SublimeLinter-contrib-proselint)
[![Build Status](https://travis-ci.org/amperser/proselint.svg?branch=master)](https://travis-ci.org/amperser/proselint)

This linter plugin for [SublimeLinter][docs] provides an interface to [proselint](http://proselint.com). It will be used with files that have the “markdown”, “text”, or “plain text” syntaxes.

## Installation
SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions [here][installation].
abbeviatable

### Linter installation
Before using this plugin, you must ensure that `proselint` is installed on your system. To install `proselint`, do the following:
Expand Down Expand Up @@ -43,18 +42,18 @@ In addition to the standard SublimeLinter settings, SublimeLinter-contrib-prosel
## Contributing
If you would like to contribute enhancements or fixes, please do the following:

1. Fork the main repository, http://github.com/amperser/proselint.
1. Hack on a separate topic branch created from the latest `master`.
1. Commit and push the topic branch.
1. Make a pull request.
1. Fork the main repository, http://github.com/amperser/proselint. This plugin can be found in `/plugins/sublime/`
1. Hack on a separate topic branch off the latest `master`.
1. Commit to the topic branch and push it.
1. Create a pull request.
1. Be patient. ;-)

Please note that modifications should follow these coding guidelines:

- Indent is 4 spaces.
- Code should pass flake8 and pep257 linters.
- Vertical whitespace helps readability, don’t be afraid to use it.
- Please use descriptive variable names, no abbreviations unless they are well known.
- Vertical whitespace helps readability; don’t be afraid to use it.
- Please use descriptive variable names. No abbreviations unless they are well known.

Thank you for helping out!

Expand Down