Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #76 from micromatch/dev
complete refactor
- Loading branch information
Showing
161 changed files
with
16,651 additions
and
9,101 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,4 +7,4 @@ | |
*.jpg binary | ||
*.gif binary | ||
*.png binary | ||
*.jpeg binary | ||
*.jpeg binary |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
# Contributing to micromatch | ||
|
||
First and foremost, thank you! We appreciate that you want to contribute to micromatch, your time is valuable, and your contributions mean a lot to us. | ||
|
||
**What does "contributing" mean?** | ||
|
||
Creating an issue is the simplest form of contributing to a project. But there are many ways to contribute, including the following: | ||
|
||
- Updating or correcting documentation | ||
- Feature requests | ||
- Bug reports | ||
|
||
If you'd like to learn more about contributing in general, the [Guide to Idiomatic Contributing](https://github.com/jonschlinkert/idiomatic-contributing) has a lot of useful information. | ||
|
||
**Showing support for micromatch** | ||
|
||
Please keep in mind that open source software is built by people like you, who spend their free time creating things the rest the community can use. | ||
|
||
Don't have time to contribute? No worries, here are some other ways to show your support for micromatch: | ||
|
||
- star the [project](https://github.com/jonschlinkert/micromatch) | ||
- tweet your support for micromatch | ||
|
||
## Issues | ||
|
||
### Before creating an issue | ||
|
||
Please try to determine if the issue is caused by an underlying library, and if so, create the issue there. Sometimes this is difficult to know. We only ask that you attempt to give a reasonable attempt to find out. Oftentimes the readme will have advice about where to go to create issues. | ||
|
||
Try to follow these guidelines | ||
|
||
- **Investigate the issue**: There might be an existing issue (open or closed) that covers the bug you experienced. If so, please do not create a new issue. If necessary you may add comments to the existing issue if you can shed additional light on the problem, or you'd like to help with debugging. | ||
- **Check the readme** - oftentimes you will find notes about creating issues, and where to go depending on the type of issue. | ||
- Create the issue in the appropriate repository: try to find out if the bug you're experiencing is in micromatch or one of its dependencies | ||
|
||
### Creating an issue | ||
|
||
Please be as descriptive as possible when creating an issue. Give us the information we need to successfully answer your question or address your issue by answering the following in your issue: | ||
|
||
- **version**: please note the version of micromatch are you using | ||
- **extensions, plugins, helpers, etc** (if applicable): please list any extensions you're using | ||
- **error messages**: please paste any error messages into the issue, or a [gist](https://gist.github.com/) | ||
|
||
## Above and beyond | ||
|
||
Here are some tips for creating idiomatic issues. Taking just a little bit extra time will make your issue easier to read, easier to resolve, more likely to be found by others who have the same or similar issue in the future. | ||
|
||
- read the [Guide to Idiomatic Contributing](https://github.com/jonschlinkert/idiomatic-contributing) | ||
- take some time to learn basic markdown. This [markdown cheatsheet](https://gist.github.com/jonschlinkert/5854601) is super helpful, as is the GitHub guide to [basic markdown](https://help.github.com/articles/markdown-basics/). | ||
- Learn about [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/). And if you want to really go above and beyond, read [mastering markdown](https://guides.github.com/features/mastering-markdown/). | ||
- use backticks to wrap code. This ensures that code will retain its format, making it much more readable to others | ||
- use syntax highlighting by adding the correct language name after the first "code fence" | ||
|
||
|
||
[micromatch]: https://github.com/jonschlinkert/micromatch |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
_(Thanks for reporting an issue to micromatch! If you haven't already read the [contributor guidelines](contributing.md), Please do that now, then procede to fill out the details below.)_ | ||
|
||
## Please describe the **minimum necessary steps** to reproduce this issue: | ||
|
||
… | ||
|
||
## What is happening (but shouldn't): | ||
|
||
… | ||
|
||
## What should be happening instead? | ||
|
||
… |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,108 @@ | ||
Hello, and thanks for contributing to micromatch! | ||
|
||
## tldr | ||
|
||
There are three main goals in this document, depending on the nature of your pr: | ||
|
||
- [description](#description): please tell us about your pr | ||
- [checklist](#checklist): please review the checklist that is most closly related to your pr | ||
- [contributors list](#packagejson-contributors): you're one of us now, please add yourself to `package.json` and let the world know! | ||
|
||
The following sections provide more detail on each. | ||
|
||
**Improve this document** | ||
|
||
Please don't hesitate to [ask questions][issues] for clarification, or to [make suggestions][issues] (or a pull request) to improve this document. | ||
|
||
## Description | ||
|
||
To help the project's maintainers and community to quickly understand the nature of your pull requeset, please create a description that incorporates the following elements: | ||
|
||
- [] what is accomplished by the pr | ||
- [] if there is something potentially controversial in your pr, please take a moment to tell us about your choices | ||
|
||
## Checklist | ||
|
||
Please use the checklist that is most closely related to your pr _(you only need to use one checklist, and you can skip items that aren't applicable or don't make sense)_: | ||
|
||
- [fixing typos]() | ||
- [documentation]() | ||
- [bug fix]() | ||
- [new feature]() | ||
- [other]() | ||
|
||
### Fixing typos | ||
|
||
- [ ] Please review the [readme advice]() section before submitting changes | ||
- [ ] Add your to the [contributors](#packagejson-contributors) array in package.json! | ||
|
||
### Documentation | ||
|
||
- [ ] Please review the [readme advice](#readme-advice) section before submitting changes | ||
- [ ] Add your info to the [contributors](#packagejson-contributors) array in package.json! | ||
|
||
### Bug Fix | ||
|
||
- [ ] All existing unit tests are still passing (if applicable) | ||
- [ ] Add new passing unit tests to cover the code introduced by your pr | ||
- [ ] Update the readme (see [readme advice](#readme-advice)) | ||
- [ ] Update or add any necessary API documentation | ||
- [ ] Add your info to the [contributors](#packagejson-contributors) array in package.json! | ||
|
||
### New Feature | ||
|
||
- [ ] If this is a big feature with breaking changes, consider [opening an issue][issues] to discuss first. This is completely up to you, but please keep in mind that your pr might not be accepted. | ||
- [ ] Run unit tests to ensure all existing tests are still passing | ||
- [ ] Add new passing unit tests to cover the code introduced by your pr | ||
- [ ] Update the readme (see [readme advice](#readme-advice)) | ||
- [ ] Add your info to the [contributors](#packagejson-contributors) array in package.json! | ||
|
||
Thanks for contributing! | ||
|
||
## Readme advice | ||
|
||
Please review this section if you are updating readme documentation. | ||
|
||
**Readme template** | ||
|
||
This project uses [verb][] for documentation. Verb generates the project's readme documentation from the [.verb.md](../.verb.md) template in the root of this project. | ||
|
||
Make all documentation changes in `.verb.md`, and please _do not edit the readme.md directly_, or your changes might accidentally get overwritten. | ||
|
||
**Code comments** | ||
|
||
Please add code comments (following the same style as existing comments) to describe any code changes or new code introduced by your pull request. | ||
|
||
**Optionally build the readme** | ||
|
||
Any changes made `.verb.md` and/or code comments will be automatically incorporated into the README documentation the next time `verb` is run. | ||
|
||
We can take care of building the documentation for you when we merge in your changes, or feel free to run [verb][] yourself. Whatever you prefer is fine with us. | ||
|
||
## package.json contributors | ||
|
||
**Add yourself!** | ||
|
||
When adding your information to the `contributors` array in package.json, please use the following format (provide your name at minimum, the other fields are optional): | ||
|
||
``` | ||
full name <email@address.com> (https://website.com) | ||
``` | ||
|
||
**Example** | ||
|
||
```json | ||
// -- package.json -- | ||
{ | ||
"name": "micromatch", | ||
"contributors": [ | ||
"Brian Woodward <jon.schlinkert@sellside.com> (https://github.com/jonschlinkert)", | ||
"Jon Schlinkert <brian.woodward@sellside.com> (https://github.com/doowb)", | ||
] | ||
} | ||
``` | ||
|
||
_(If a `contributors` array does not already exist, please feel free to add one wherever you want, and congratulations on being the first to contribute!)_ | ||
|
||
[issues]: ../../issues | ||
[verb]: https://github.com/verbose/verb |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,27 @@ | ||
# always ignore files | ||
*.DS_Store | ||
*.sublime-* | ||
_gh_pages | ||
bower_components | ||
|
||
# test related, or directories generated by tests | ||
test/actual | ||
actual | ||
coverage | ||
.nyc* | ||
|
||
# npm | ||
node_modules | ||
npm-debug.log | ||
|
||
# yarn | ||
yarn.lock | ||
yarn-error.log | ||
|
||
# misc | ||
_gh_pages | ||
_draft | ||
_drafts | ||
bower_components | ||
vendor | ||
temp | ||
tmp | ||
TODO.md | ||
vendor | ||
*.DS_Store | ||
staging | ||
wip | ||
test/bash | ||
coverage |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,13 @@ | ||
sudo: false | ||
os: | ||
- linux | ||
- osx | ||
language: node_js | ||
node_js: | ||
- node | ||
- '7' | ||
- '6' | ||
- '5' | ||
- '4' | ||
- '0.12' | ||
- '0.10' | ||
matrix: | ||
fast_finish: true | ||
allow_failures: | ||
- node_js: '0.10' |
Oops, something went wrong.