Skip to content

Commit 11c317a

Browse files
thedaviddiasthedaviddias
committed
docs: update md files + add travis
1 parent 9b8eba0 commit 11c317a

File tree

9 files changed

+241
-25
lines changed

9 files changed

+241
-25
lines changed

‎.editorconfig

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# EditorConfig helps developers define and maintain consistent
2+
# coding styles between different editors and IDEs
3+
# editorconfig.org
4+
5+
root = true
6+
7+
8+
[*]
9+
10+
# Change these settings to your own preference
11+
indent_style = space
12+
indent_size = 2
13+
14+
# We recommend you to keep these unchanged
15+
end_of_line = lf
16+
charset = utf-8
17+
trim_trailing_whitespace = true
18+
insert_final_newline = true
19+
20+
[*.md]
21+
trim_trailing_whitespace = false
22+
23+
[*.py]
24+
indent_size = 4

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
5+
---
6+
7+
**Describe the bug**
8+
A clear and concise description of what the bug is.
9+
10+
**To Reproduce**
11+
Steps to reproduce the behavior:
12+
1. Go to '...'
13+
2. Click on '....'
14+
3. Scroll down to '....'
15+
4. See error
16+
17+
**Expected behavior**
18+
A clear and concise description of what you expected to happen.
19+
20+
**Screenshots**
21+
If applicable, add screenshots to help explain your problem.
22+
23+
**Desktop (please complete the following information):**
24+
- OS: [e.g. iOS]
25+
- Browser [e.g. chrome, safari]
26+
- Version [e.g. 22]
27+
28+
**Smartphone (please complete the following information):**
29+
- Device: [e.g. iPhone6]
30+
- OS: [e.g. iOS8.1]
31+
- Browser [e.g. stock browser, safari]
32+
- Version [e.g. 22]
33+
34+
**Additional context**
35+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
5+
---
6+
7+
**Is your feature request related to a problem? Please describe.**
8+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
9+
10+
**Describe the solution you'd like**
11+
A clear and concise description of what you want to happen.
12+
13+
**Describe alternatives you've considered**
14+
A clear and concise description of any alternative solutions or features you've considered.
15+
16+
**Additional context**
17+
Add any other context or screenshots about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
**Fixes**: #
2+
3+
🚨 Please review the [guidelines for contributing](./CONTRIBUTING.md) and our [code of conduct](./CODE_OF_CONDUCT.md) to this repository. 🚨
4+
**Please complete these steps and check these boxes (by putting an x inside the brackets) before filing your PR:**
5+
6+
- [ ] Check the commit's or even all commits' message styles matches our requested structure.
7+
- [ ] Check your code additions will fail neither code linting checks nor unit test.
8+
9+
#### Short description of what this resolves:
10+
11+
#### Proposed changes:
12+
13+
## -
14+
15+
-
16+
17+
👍 Thank you!

‎.gitignore

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
11
.DS_Store
2+
node_modules/
3+
npm-debug.log*
4+
yarn-debug.log*
5+
yarn-error.log*
6+
test/unit/coverage
7+
test/e2e/reports
8+
selenium-debug.log
9+
dist/
10+
.tmp/
11+
coverage
12+
.nyc_output
13+
14+
# Editor directories and files
15+
.idea
16+
.vscode
17+
*.suo
18+
*.ntvs*
19+
*.njsproj
20+
*.sln
221
*.sublime-*
322

‎CODE_OF_CONDUCT.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
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.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
- Using welcoming and inclusive language
12+
- Being respectful of differing viewpoints and experiences
13+
- Gracefully accepting constructive criticism
14+
- Focusing on what is best for the community
15+
- Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
- Trolling, insulting/derogatory comments, and personal or political attacks
21+
- Public or private harassment
22+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
- Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
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.
28+
29+
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.
30+
31+
## Scope
32+
33+
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.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. 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.
38+
39+
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.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [https://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: https://contributor-covenant.org
46+
[version]: https://contributor-covenant.org/version/1/4/

‎CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contribute
2+
3+
## Introduction
4+
5+
First, thank you for considering contributing to HTMLHint! It's people like you that make the open source community such a great community! 😊
6+
7+
We welcome any type of contribution, not only code. You can help with
8+
- **QA**: file bug reports, the more details you can give the better (e.g. screenshots with the console open)
9+
- **Marketing**: writing blog posts, howto's, printing stickers, ...
10+
- **Community**: presenting the project at meetups, organizing a dedicated meetup for the local community, ...
11+
- **Code**: take a look at the [open issues](https://github.com/htmlhint/SublimeLinter-contrib-htmlhint/issues). Even if you can't write code, commenting on them, showing that you care about a given issue matters. It helps us triage them.
12+
13+
## Your First Contribution
14+
15+
Working on your first Pull Request? You can learn how from this *free* series, [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
16+
17+
## Submitting code
18+
19+
Any code change should be submitted as a pull request. The description should explain what the code does and give steps to execute it. The pull request should also contain tests.
20+
21+
## Code review process
22+
23+
The bigger the pull request, the longer it will take to review and merge. Try to break down large pull requests in smaller chunks that are easier to review and merge.
24+
It is also always helpful to have some context for your pull request. What was the purpose? Why does it matter to you?
25+
26+
## Questions
27+
28+
If you have any questions, create an [issue](issue) (protip: do a quick search first to see if someone else didn't ask the same question before!).
29+
You can also reach us at [email protected].
30+
31+
<!-- This `CONTRIBUTING.md` is based on @nayafia's template https://github.com/nayafia/contributing-template -->

‎LICENSE renamed to ‎LICENSE.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,23 @@
1+
MIT License
2+
3+
Copyright (c) 2015-2018 / Mark Maday @mmaday ([email protected])
4+
5+
Copyright (c) 2018 / HTMLHint ([email protected]) / David Dias @thedaviddias ([email protected])
6+
17
Permission is hereby granted, free of charge, to any person obtaining a copy
28
of this software and associated documentation files (the "Software"), to deal
39
in the Software without restriction, including without limitation the rights
410
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
511
copies of the Software, and to permit persons to whom the Software is
612
furnished to do so, subject to the following conditions:
713

8-
The above copyright notice and this permission notice shall be included in
9-
all copies or substantial portions of the Software.
14+
The above copyright notice and this permission notice shall be included in all
15+
copies or substantial portions of the Software.
1016

1117
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
1218
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
1319
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
1420
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1521
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
16-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
17-
THE SOFTWARE.
22+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23+
SOFTWARE.

‎README.md

Lines changed: 42 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,43 @@
1-
SublimeLinter-contrib-htmlhint
2-
================================
3-
4-
<!--- [![Build Status](https://travis-ci.org/SublimeLinter/SublimeLinter-contrib-htmlhint.svg?branch=master)](https://travis-ci.org/SublimeLinter/SublimeLinter-contrib-htmlhint) -->
1+
<h1 align="center">
2+
<br>
3+
SublimeLinter contrib HTMLHint
4+
<br>
5+
</h1>
6+
7+
<h4 align="center">A SublimeLinter plugin for HTML, using HTMLHint.</h4>
8+
9+
<p align="center">
10+
<a href="https://travis-ci.org/htmlhint/SublimeLinter-contrib-htmlhint">
11+
<img src="https://img.shields.io/travis/htmlhint/SublimeLinter-contrib-htmlhint.svg" alt="Travis Build Status">
12+
</a>
13+
<a href="https://codecov.io/gh/htmlhint/SublimeLinter-contrib-htmlhint">
14+
<img src="https://codecov.io/gh/htmlhint/SublimeLinter-contrib-htmlhint/branch/master/graph/badge.svg" alt="Codecov">
15+
</a>
16+
<a href="https://www.npmjs.com/package/SublimeLinter-contrib-htmlhint">
17+
<img src="https://img.shields.io/npm/dm/SublimeLinter-contrib-htmlhint.svg" alt="NPM count">
18+
</a>
19+
<img src="https://badgen.net/badge/license/MIT/green" alt="MIT Licence" />
20+
<a href="https://discord.gg/nJ6J9CP">
21+
<img src="https://img.shields.io/badge/chat-on%20discord-7289da.svg" alt="Chat">
22+
</a>
23+
<a href="http://roadmap.htmlhint.io/roadmap">
24+
<img src="https://img.shields.io/badge/check-our%20roadmap-EE503E.svg" alt="Chat">
25+
</a>
26+
</p>
27+
28+
<p align="center">
29+
  <a href="#install">How To Use</a> • <a href="/CONTRIBUTING.md">Contributing</a> • <a href="http://roadmap.htmlhint.io/">Roadmap</a> • <a href="https://htmlhint.io">Website</a>
30+
</p>
31+
32+
## Table of Contents
33+
34+
- **[Install](#install)**
35+
- **[Settings](#settings)**
536

637
This linter plugin for [SublimeLinter][docs] provides an interface to [htmlhint](http://htmlhint.com/). It will be used with files that have the “HTML” syntax.
738

8-
## Installation
9-
SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions [here][installation].
39+
## Install
40+
SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions [here][install].
1041

1142
### Linter installation
1243
Before using this plugin, you must ensure that `htmlhint` is installed on your system. To install `htmlhint`, do the following:
@@ -42,30 +73,20 @@ To install via Package Control, do the following:
4273
1. When the plugin list appears, type `htmlhint`. Among the entries you should see `SublimeLinter-contrib-htmlhint`. If that entry is not highlighted, use the keyboard or mouse to select it.
4374

4475
## Settings
76+
4577
For general information on how SublimeLinter works with settings, please see [Settings][settings]. For information on generic linter settings, please see [Linter Settings][linter-settings].
4678

4779
You can configure `htmlhint` options in the way you would from the command line, with `.htmlhintrc` files. For more information, see the [htmlhintrc docs](https://github.com/yaniswang/HTMLHint/wiki/Rules). The linter plugin does this by searching for a `.htmlhintrc` file itself, just as `htmlhint` does from the command line. You may provide a custom config file by setting the linter’s `"args"` setting to `["--config", "/path/to/file"]`. On Windows, be sure to double the backslashes in the path, for example `["--config", "C:\\Users\\Username\\htmlhint.conf"]`.
4880

4981
The path to the `.htmlhintrc` file is cached, meaning if you create a new `.htmlhintrc` that should have precedence over the previous one (meaning it is closer to the .js file) you need to clear the cache for the linter to use the new `.htmlhintrc` You can clear the cache by going to: Tools > SublimeLinter > Clear Caches.
5082

83+
## LICENCE
5184

52-
## Contributing
53-
If you would like to contribute enhancements or fixes, please do the following:
54-
55-
1. Fork the plugin repository.
56-
1. Hack on a separate topic branch created from the latest `master`.
57-
1. Commit and push the topic branch.
58-
1. Make a pull request.
59-
1. Be patient. ;-)
60-
61-
Please note that modifications should follow these coding guidelines:
85+
Project initially created by [@mmaday](https://github.com/mmaday) and transferred to the [HTMLHint](https://github.com/htmlhint) organization.
6286

63-
- Indent is 4 spaces.
64-
- Code should pass flake8 and pep257 linters.
65-
- Vertical whitespace helps readability, don’t be afraid to use it.
66-
- Please use descriptive variable names, no abbreviations unless they are very well known.
87+
<a href="https://htmlhint.io"><img src="https://raw.githubusercontent.com/htmlhint/htmlhint/develop/src/img/htmlhint.png" alt="Logo HTMLHint" width="65"></a>
6788

68-
Thank you for helping out!
89+
[MIT License](./LICENSE)
6990

7091
[docs]: http://sublimelinter.readthedocs.org
7192
[installation]: http://sublimelinter.readthedocs.org/en/latest/installation.html

0 commit comments

Comments
 (0)