Skip to content

Commit

Permalink
init(all): init commit → ★
Browse files Browse the repository at this point in the history
  • Loading branch information
fetchTe committed Jun 15, 2017
0 parents commit c8675ec
Show file tree
Hide file tree
Showing 26 changed files with 10,269 additions and 0 deletions.
16 changes: 16 additions & 0 deletions .babelrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"presets": [
["env", {
"targets": {
"browsers": ["last 4 versions"]
},
"include": ["transform-regenerator"]
}]
],
"plugins": [
["transform-runtime", {
"polyfill": false,
"regenerator": true
}]
]
}
38 changes: 38 additions & 0 deletions .cz-config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@

module.exports = {
types: [
{value: 'chore', name: 'chore: Changes to the build process or auxiliary tools\n and libraries such as documentation generation'},
{value: 'docs', name: 'docs: Documentation only changes'},
{value: 'feat', name: 'feat: A new feature'},
{value: 'fix', name: 'fix: A bug fix'},
{value: 'init', name: 'init: Initial commit'},
{value: 'perf', name: 'perf: A code change that improves performance'},
{value: 'refactor', name: 'refactor: A code change that neither fixes a bug nor adds a feature'},
{value: 'release', name: 'release: A code release and tag'},
{value: 'revert', name: 'revert: Revert to a commit'},
{value: 'style', name: 'style: Changes that do not affect the meaning of the code\n (white-space, formatting, missing semi-colons, etc)'},
{value: 'syntax', name: 'syntax: Spelling, grammar, punctuation, or mechanics'},
{value: 'update', name: 'update: Updates feature'},
{value: 'test', name: 'test: Adding missing tests'},
{value: 'WIP', name: 'WIP: Work in progress'}
],
// scopes: {Array of Strings}: Specify the scopes for your particular project.
// Eg.: for some banking system: ["acccounts", "payments"].
// For another travelling application: ["bookings", "search", "profile"]
scopes: [
{name: 'lib'},
{name: '__scripts__'},
{name: '__tests__'},
{name: 'root'}
],
// scopeOverrides: {Object where key contains a Array of String}:
// Use this when you want to override scopes for a specific commit type.
// Example bellow specify scopes when type is fix:
scopeOverrides: {},
// allowCustomScopes: {boolean, default false}: adds the option custom to
// scope selection so you can still typea scope if you need.
allowCustomScopes: true,
// allowBreakingChanges: {Array of Strings: default none}. List of commit
// types you would like to the question breaking change prompted. Eg.: ['feat', 'fix']
allowBreakingChanges: ['feat', 'fix']
};
206 changes: 206 additions & 0 deletions .eslintrc.js

Large diffs are not rendered by default.

13 changes: 13 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# See https://help.github.com/articles/dealing-with-line-endings

# These files are text and should be normalized (Convert crlf => lf)
*.md text
*.txt text
*.html text
*.css text
*.js text

# Denote all files that are truly binary and should not be modified.
*.png binary
*.jpg binary
*.pdf binary
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!--
(INFORMATION):
+ Contributions are welcomed and appreciated with open hearts and open fingers. Before you continue, consider the following: If you have a "How do I do ...?" question, this is not the proper channel. Instead, please use stackoverflow: stackoverflow.com/questions/tagged/firemap
+ These "Issues" are meant for technical problems, bugs, and proposals related to the library, although, exceptions are made for noteworthy cases. If you're reporting a bug, please use the below bug template.
(BUG TEMPLATE):
#### What's your environment:
#### Expected behavior:
#### Actual behavior:
#### What steps and/or code will reproduce the bug:
#### Have you identified what's causing the bug and/or potential solutions:
#### Additional information and details:
-->
12 changes: 12 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
#### Description:
<!--- CLOSES #X -->
<!--- Describe your changes in detail, need be. -->
<!--- Why is this change required and/or what problem does it solve? -->
<!--- If there are breaking changes, please make a note of them. -->

#### Checklist:
<!--- All the checkboxes must be checked even if they do not pertain -->
- [ ] Update/change/fix has/passes test(s)
- [ ] Follows the existing code style
- [ ] Has decent commit message
- [ ] Commit and code comes with a smile
52 changes: 52 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Custom/library specific


# Global
*~
# KDE directory preferences
.directory
# Linux trash folder which might appear on any partition or disk
.Trash-*
# cache files for sublime text
*.tmlanguage.cache
*.tmPreferences.cache
*.stTheme.cache
# workspace files are user-specific
*.sublime-workspace
# project files should be checked into the repository, unless a significant
# proportion of contributors will probably not be using SublimeText
# *.sublime-project
# sftp configuration file
sftp-config.json
# Logs
logs
*.log
npm-debug.log*
# Packages
node_modules/
bower_components/
# Misc
.DS_Store
.public
.publish
.directory
.temp
public
private
_private
.private
.iron-node.js
Desktop.ini
app/assets/stylesheets/generated
lib-cov
*.seed
*.log
*.csv
*.dat
*.out
*.pid
*.gz
pids
logs
results
tmp
52 changes: 52 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Custom/library specific


# Global
*~
# KDE directory preferences
.directory
# Linux trash folder which might appear on any partition or disk
.Trash-*
# cache files for sublime text
*.tmlanguage.cache
*.tmPreferences.cache
*.stTheme.cache
# workspace files are user-specific
*.sublime-workspace
# project files should be checked into the repository, unless a significant
# proportion of contributors will probably not be using SublimeText
# *.sublime-project
# sftp configuration file
sftp-config.json
# Logs
logs
*.log
npm-debug.log*
# Packages
node_modules/
bower_components/
# Misc
.DS_Store
.public
.publish
.directory
.temp
public
private
_private
.private
.iron-node.js
Desktop.ini
app/assets/stylesheets/generated
lib-cov
*.seed
*.log
*.csv
*.dat
*.out
*.pid
*.gz
pids
logs
results
tmp
34 changes: 34 additions & 0 deletions .zappr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# docs: https://zappr.readthedocs.io/en/latest/setup/
approvals:
# PR needs at least 1 approvals
minimum: 1
# approval = comment that matches this regex
pattern: "^(:\\+1:|👍|\\+1|LGTM)$"
veto:
# veto/blocking a PR = comment that matches this regex
pattern: "^(:\\-1:|👎|\\-1|LBTM)$"
# note that `from` is by default empty,
# accepting any matching comment as approval
from:
# commenter must be either one of:
orgs:
# a public zalando org member
# (any org in here counts)
# - your-organization
# OR a collaborator of the repo
collaborators: true
# OR one of these guys
users:
- artisin
specification:
# title requirements
title:
# PR title is at least this many characters long
minimum-length:
enabled: true
length: 8
commit:
message:
# commit message has to match any one of
patterns:
- "\\(.*?\\):"
Empty file added CHANGELOG.md
Empty file.
102 changes: 102 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
# Contributing

A healthy community is a contributing community, and contributions are welcomed and appreciated with open hearts and open fingers. First things first, make sure you [search the issue tracker](https://github.com/artisin/firemap/issues) to ensure your issue/fix/update has not previously been discussed and/or fixed in the `master`. Additionally, if you're planning to implement a new feature, change the API, or any change that will take over a handful of minutes, please create an issue first and wait for a response from one of the maintainers. Otherwise, there are no guarantees your hard work will be merged, and then we will feel shitty that you feel shitty since all your efforts will have been for naught.


## Issue Tracker

The [issue tracker](https://github.com/artisin/firemap/issues) is the preferred channel for [bug reports](#bug-reports), [features requests](#feature-requests), and [submitting pull requests](#pull-requests). Please respect the following guidelines:

+ Please **do not** use the issue tracker for personal support requests (use [Stack Overflow](https://stackoverflow.com/questions/tagged/firemap)).
+ Please **do not** post comments consisting solely of "+1" or ":+1:".
+ Keep the discussion on topic, respect the opinions of others, and most importantly don't be a prick; or in other words, don't be a fucking asshole.


## Bug Reports

A "bug" is defined as a demonstrable problem that is caused by the code in the repository. If you find a bug, please report it so we can fix it. Remember, you're the first defense against the war on bugs.

__Guidelines for bug reports__:

1. Use the GitHub [issue](https://github.com/artisin/firemap/issues) search, and check if the issue has already been reported.
2. Try to reproduce the bug using the latest `master` (or `development` if present) branch in the repository.
3. Isolate the problem, and ideally, create a test case and/or upload the code to a repository or post the code inline if the size is reasonable.

A good bug report shouldn't leave others needing to chase you down for more information. Please try to be as detailed as possible in your report. It's important you include the following:

+ What's your environment?
+ Expected behavior
+ Actual behavior
+ What steps and/or code will reproduce the bug?
+ Have you identified what's causing the bug, and potential solutions or opinions?
+ Any other useful details that will help fix the potential bugs.


## Feature Requests

Feature requests are welcomed. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case and demonstrate the merits of this feature. Furthermore, provide as much detail and context as possible.


## Pull Requests

1. [Fork](https://help.github.com/fork-a-repo/) the repository.

```bash
git clone https://github.com/<your-username>/firemap.git
cd firemap
git remote add upstream https://github.com/artisin/firemap.git
```

2. Link `firemap`, to symlink the package folder during development.

```bash
yarn run link
```

3. Install the dependencies. Make sure you have [yarn](https://yarnpkg.com) [installed](https://yarnpkg.com/en/docs/install).

```bash
yarn install
```

4. Create a new branch to contain your feature, change, or fix.

```bash
git checkout -b <topic-branch-name>
```

5. Commit your changes in logical chunks.
+ To keep commits uniform, this project uses [commitizen](http://commitizen.github.io/cz-cli/), but don't worry if you've never heard about commitizen or don't know how to use it. Everything is pre-configured and ready for you to rock 'n' roll out of the box. Just follow these simple steps:
1. Make your update/change/fix
2. Add your changes `git add .`
3. Run: `npm run commit` - An interactive command prompt will appear and lead you step-by-step through the whole process. It's easy peasy lemon squeezy so don't worry about a thing.
+ If commitizen does not work or for some extraneous reason you wish not to use it your commit must follow the [angular commit](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) format: `<type>(<scope>): <subject>`. Otherwise, your pull request will fail during approval, but it’s highly encouraged you use `npm run commit` to make everyone's life just a bit easier.

6. Test changes and/or write test(s) to validate feature, change, or fix.

```bash
yarn run test
```

7. Locally merge (or rebase) the upstream development branch into your topic branch.

```bash
git pull [--rebase] upstream master
```

8. Push your topic branch up to your fork.

```bash
git push origin <topic-branch-name>
```

9. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) with a clear title and description against the `master` branch. Suggestions, changes, or improvements may be required for your changes to be merged, but small pull requests should be accepted quickly. Ideally, your pull request meets the four pillars of quality:
1. Update/change/fix has test(s)
2. Follows the existing code style
3. Has decent commit message(s)
4. Commit, and code comes with a smile


# License

**IMPORTANT:** By contributing your code, you agree to license your contribution under the [MIT](https://github.com/artisin/firemap/blob/master/LICENSE.txt) License.
22 changes: 22 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
The MIT License

Copyright (c) 2017 te schultz
https://github.com/artisin/firemap

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

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

0 comments on commit c8675ec

Please sign in to comment.