Skip to content

Commit

Permalink
Merge pull request #164 from linterhub/develop
Browse files Browse the repository at this point in the history
Release v1.0.0
  • Loading branch information
itekaf committed Aug 20, 2018
2 parents f5777bb + f6e2688 commit 366e439
Show file tree
Hide file tree
Showing 65 changed files with 2,638 additions and 63 deletions.
1 change: 1 addition & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules/**
10 changes: 10 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"env": {
"es6": true,
"node": true
},
"rules": {
"indent": ["error", 4, { "SwitchCase": 1 }]
},
"extends": "google"
}
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Default behavior
* text=auto
74 changes: 74 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Contributor Covenant Code of Conduct

## 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, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

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

## 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 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.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and 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.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

145 changes: 145 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
# CONTRIBUTING

## Table of Contents

- [Welcome](#welcome)
- [Issue](#issue)
- [Reporting a bug](#reporting-a-bug)
- [Request a feature](#request-a-feature)
- [Other questions](#other-questions)
- [Pull Request](#pull-request)

## Welcome

When contributing to this repository, please first discuss the change you
want to make via [`issue`](#issue), [`@linterhub/maintainers`][maintainers],
or use any other method before making a change.

## Issue

If you have any questions, or you've found a bug or want to share any idea,
please create the relevant issue in this repository.

Please take into account of our wishes for work with issues:

- Use the GitHub issue search — to ensure that the issue hasn't been already reported.
- The issue tracker shouldn't be used for personal support requests.

### Reporting a bug

A bug is a demonstrable problem caused by the code in the repository.
Thank you for essential bug reports!

Guidelines for bug reports:

- Check if the issue has been fixed and try to reproduce it using the latest `develop` branch in the repository.
- Isolate the problem by creating a test case and a live example.

A good bug report shouldn't leave others to need to reach you for
more information. Please try to be as detailed as possible as all details
listed will help us to fix the found issues.

Create issue: [`reporting a bug`][github-url-issue]

### Request a feature

We welcome feature requests but take some time to ensure that your idea fits
with the scope and aims of our project. Please provide as much detail and
context as possible.

Create issue: [`request a feature`][github-url-issue]

### Other questions

You can send you questions in [`@linterhub/maintens`][maintainers] or create
an issue: [`custom issue`][github-url-issue]

## Pull Request

Please reach us before submitting any significant pull request (e.g.
implementing features, refactoring code), otherwise, you risk spending a
lot of time working on something that is not likely to be merged
into the project.

Please adhere to the coding conventions used throughout a project (indentation,
accurate comments, etc.).

Follow this process if you want your work to be included in our project:

### STEP 1: Fork and clone

Fork the [`linterhub/usage-parser`][github-url] repo and then clone it.

> Note: More information about creating a fork and cloning your fork to local folder read in [`git help`][github-help-fork]
### STEP 2: Get the latest changes

```bash
git checkout develop
```

### STEP 3: Install

```bash
npm install
```

### STEP 4: Create a new branch

```bash
git checkout -b type/issue-short-name
```

Where:

- `type` - is a [semantic type][github-url-commit-message] for commits
- `issue-short-name` - is a short name of issue. Please use `-` delimiters.

> Note: Do not combine fixes for multiple issues into one branch
### STEP 5: Make your changes

Make the changes, following the code conventions. Once you finished,
run following command:

```bush
npm run test
```

If errors not found you can commit the changes to your branch:

```bush
git add -A .
git commit
```

Commit your changes using a descriptive commit message that follows
our [commit message conventions][github-url-commit-message].

### STEP 6: Double check your submission

Make sure your commit has the right format:

- The commit message is [properly formatted][github-url-commit-message].
- The change causes no functional regression. Be sure to run a test to verify your changes before submitting a pull request.
- All changes must be accompanied by tests, even if the feature you’re working on previously had no tests.
- All user-facing changes must be accompanied by the correspondent documentation.

### STEP 7: Push your changes

```bush
git push
```

### STEP 8: Send the pull request

Go to your fork in GitHub and then follow the [GitHub documentation][github-help-pull-request] on how to send a pull request.

- A pull request must contain a description explaining what you did and how the effects can be seen.

[maintainers]: https://github.com/orgs/linterhub/teams/maintainers
[github-url]: https://github.com/linterhub/usage-parser
[github-url-issue]: https://github.com/linterhub/usage-parser/issues/new
[github-help-fork]: https://help.github.com/articles/fork-a-repo/#fork-an-example-repository
[github-help-pull-request]: https://help.github.com/articles/creating-a-pull-request
[github-url-commit-message]: https://github.com/linterhub/usage-parser/blob/develop/docs/git/commit_message.md
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Expected Behavior

## Actual Behavior

## Steps to Reproduce the Problem
5 changes: 5 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Proposed Changes

-
-
-
71 changes: 71 additions & 0 deletions .github/settings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Pull Requests for GitHub repository settings https://github.com/apps/settings
repository:
# A short description of the repository that will show up on GitHub
description: Usage parser

# A URL with more information about the repository
homepage: https://github.com/linterhub/usage-parser

# Either `true` to enable issues for this repository, `false` to disable them.
has_issues: true

# Either `true` to enable the wiki for this repository, `false` to disable it.
has_wiki: false

# Either `true` to enable downloads for this repository, `false` to disable them.
has_downloads: true

# Updates the default branch for this repository.
default_branch: develop

# Either `true` to allow squash-merging pull requests, or `false` to prevent
# squash-merging.
allow_squash_merge: false

# Either `true` to allow merging pull requests with a merge commit, or `false`
# to prevent merging pull requests with merge commits.
allow_merge_commit: false

# Either `true` to allow rebase-merging pull requests, or `false` to prevent
# rebase-merging.
allow_rebase_merge: true

# Labels: define labels for Issues and Pull Requests
# Colors and idea are from https://github.com/yoshuawuyts/github-standard-labels
# and http://issuelabeling.com/
labels:
- name: "Priority: High"
color: FF0000
- name: "Priority: Medium"
color: FF8080
- name: "Priority: Low"
color: FFE6E6
- name: "Type: Bug"
color: 0000FF
- name: "Type: Feature"
color: 4040FF
- name: "Type: Maintenance"
color: 8080FF
- name: "Type: Question"
color: BFBFFF
- name: "Type: CI"
color: BFBFFF
- name: "Type: Documentation"
color: E6E6FF
- name: "Type: Test"
color: 8080FF
- name: "Status: Available"
color: 60BF60
- name: "Status: Blocked"
color: 008000
- name: "Status: In Progress"
color: 60BF60
- name: "Status: On Hold"
color: A8E0A8
- name: "Status: Pending"
color: 0E8C0E
- name: "Status: Rejected"
color: DAF2DA
# Add areas by using the following template
# - name: "Area: API
# color: 1d76db
65 changes: 4 additions & 61 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,61 +1,4 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# nyc test coverage
.nyc_output

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# TypeScript v1 declaration files
typings/

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env

# next.js build output
.next
/build/
/dist/
/node_modules/
package-lock.json
Loading

0 comments on commit 366e439

Please sign in to comment.