Skip to content

Commit f50d12a

Browse files
author
kaptinlin
committed
Release v0.3.0
1 parent 17120af commit f50d12a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+12798
-2395
lines changed

.eslintrc.yml

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -85,13 +85,7 @@ rules:
8585
no-labels: "error"
8686
no-lone-blocks: "error"
8787
no-loop-func: "error"
88-
no-magic-numbers:
89-
- "error"
90-
-
91-
ignore:
92-
- -1
93-
- 0
94-
- 1
88+
no-magic-numbers: "off"
9589
no-multi-spaces: "off"
9690
no-multi-str: "error"
9791
no-native-reassign: "error"

.github/ISSUE_TEMPLATE.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<!-- THIS IS AN EXAMPLE TEMPLATE.
2+
Screenshots are more than welcome!
3+
Please remove any unused content (including these instructions) before submitting your issue.
4+
Thanks for helping out! 😇-->
5+
6+
_[Remove this line and all of the above before submitting your issue]_
7+
8+
### Checklist
9+
* [ ] I'm using **version** [x.x.x]
10+
* [ ] My **browser** is:
11+
* [ ] This is a **Sass** issue: I'm using version [x.x.x]
12+
* [ ] I am sure this issue is **not a duplicate**?
13+
14+
### Description
15+
16+
[Description of the bug, enhancement, or question]
17+
[Please tag accordingly]
18+
19+
### How can we reproduce this bug?
20+
21+
1. [First Step]
22+
2. [Second Step]
23+
3. [and so on...]
24+
25+
### What did you expect to happen?
26+
27+
### What happened instead?

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<!--
2+
THIS IS AN EXAMPLE TEMPLATE.
3+
Screenshots are more than welcome!
4+
Please remove any unused content (including these instructions) before submitting your PR.
5+
Thanks for helping out! 😇
6+
7+
* Pull the latest master branch
8+
* Run `npm install` to install all dependencies
9+
* If your PR fixes an issue, reference that issue
10+
* If your PR has lots of commits, **squash** your commits first
11+
* Run `npm run build` before submitting your PR
12+
-->
13+
14+
_[Remove this line and all of the above before submitting your PR]_
15+
16+
### Pull Request
17+
18+
Fixes #
19+
20+
Changes proposed:
21+
22+
* [ ] Add
23+
* [ ] Fix
24+
* [ ] Remove
25+
* [ ] Update

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ screenshots
1515
# Dependency directories #
1616
##########################
1717
bower_components
18+
node_modules
1819

1920
#######
2021
# OSX #

.npmignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
.eslintrc.yml
88
.github
99
.gitattributes
10+
.release.json
1011
_build
1112
bower.json
1213
composer.json

.release.json

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"verbose": false,
3+
"force": false,
4+
"pkgFiles": ["package.json", "bower.json"],
5+
"increment": "patch",
6+
"commitMessage": "Release v%s",
7+
"tagName": "v%s",
8+
"tagAnnotation": "Release v%s",
9+
"buildCommand": "gulp build",
10+
"npm": {
11+
"publish": true
12+
}
13+
}

CONTRIBUTING.md

Lines changed: 83 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Guidelines for bug reports:
3636
latest `master` or development branch in the repository.
3737

3838
3. **Provide environment details.** Provide your operating system, browser(s),
39-
devices, and jquery-asScrollbar version.
39+
devices, and jquery-slidePanel version.
4040

4141
4. **Create an isolated and reproducible test case.** Create a [reduced test
4242
case](http://css-tricks.com/6263-reduced-test-cases/).
@@ -76,26 +76,90 @@ fits with the scope and aims of the project. It's up to *you* to make a strong
7676
case to convince the project's developers of the merits of this feature. Please
7777
provide as much detail and context as possible.
7878

79-
## Pull Request Guidelines
8079

81-
You must understand that by contributing code to this project, you are granting
82-
the authors (and/or leaders) of the project a non-exclusive license to
83-
re-distribute your code under the current license and possibly re-license the
84-
code as deemed necessary.
80+
## Pull Requests
8581

86-
* To instantiate a context or use it, use the variable **that** instead of
87-
**_this**.
88-
* Please check to make sure that there aren't existing pull requests attempting
89-
to address the issue mentioned. We also recommend checking for issues related
90-
to the issue on the tracker, as a team member may be working on the issue in
91-
a branch or fork.
92-
* Non-trivial changes should be discussed in an issue first
93-
* If your change affects the distributed files, re-generate them using the
94-
[gulp procedure](#using-gulp)
95-
* If possible, add relevant tests to cover the change
96-
* Write a convincing description of your PR and why we should land it
82+
**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)
9783

98-
## Using Gulp
84+
Good pull requests - patches, improvements, new features - are a fantastic
85+
help. They should remain focused in scope and avoid containing unrelated
86+
commits.
87+
88+
**Please ask first** before embarking on any significant pull request (e.g.
89+
implementing features, refactoring code, porting to a different language),
90+
otherwise you risk spending a lot of time working on something that the
91+
project's developers might not want to merge into the project.
92+
93+
Please adhere to the coding conventions used throughout a project (indentation,
94+
accurate comments, etc.) and any other requirements (such as test coverage).
95+
96+
Follow this process if you'd like your work considered for inclusion in the
97+
project:
98+
99+
1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork,
100+
and configure the remotes:
101+
102+
```bash
103+
# Clone your fork of the repo into the current directory
104+
git clone https://github.com/<your-username>/<repo-name>
105+
# Navigate to the newly cloned directory
106+
cd <repo-name>
107+
# Assign the original repo to a remote called "upstream"
108+
git remote add upstream https://github.com/<upstream-owner>/<repo-name>
109+
```
110+
111+
2. If you cloned a while ago, get the latest changes from upstream:
112+
113+
```bash
114+
git checkout <dev-branch>
115+
git pull upstream <dev-branch>
116+
```
117+
118+
3. Create a new topic branch (off the main project development branch) to
119+
contain your feature, change, or fix:
120+
121+
```bash
122+
git checkout -b <topic-branch-name>
123+
```
124+
125+
4. Commit your changes in logical chunks. Please adhere to these [git commit
126+
message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
127+
or your code is unlikely be merged into the main project. Use Git's
128+
[interactive rebase](https://help.github.com/articles/interactive-rebase)
129+
feature to tidy up your commits before making them public.
130+
131+
5. Locally merge (or rebase) the upstream development branch into your topic branch:
132+
133+
```bash
134+
git pull [--rebase] upstream <dev-branch>
135+
```
136+
137+
6. Push your topic branch up to your fork:
138+
139+
```bash
140+
git push origin <topic-branch-name>
141+
```
142+
143+
7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/)
144+
with a clear title and description.
145+
146+
**IMPORTANT**: By submitting a patch, you agree to allow the project owner to
147+
license your work under the same license as that used by the project.
148+
149+
150+
## Code Consitency
151+
152+
To help create consistent looking code throughout the project, we use a few tools to help us.
153+
154+
#### ESlint
155+
We use [ESlint](http://eslint.org) on each build to find easy-to-catch errors and potential problems in our js. You can find our ESlint settings in the `.eslintrc.yml` file in the root of the project.
156+
157+
#### EditorConfig
158+
159+
We use [EditorConfig](http://EditorConfig.org) to maintain consistent coding styles between various editors and IDEs. You can find our settings in the `.editorconfig` file in the root of the project.
160+
161+
162+
## Development
99163

100164
We are using node, gulp and babel to build and (in the future) test this project. This means that you must setup a local development environment:
101165

@@ -110,7 +174,7 @@ We are using node, gulp and babel to build and (in the future) test this project
110174
- `gulp serve` Start server with Browsersync.
111175
- `gulp clean` Clean output directories.
112176
- `gulp bundler` Bundle javasript modules.
113-
- `gulp scripts` Concatenate and minify JavaScript.
177+
- `gulp scripts` Concatenate and minify JavaScript to `dist`.
114178
- `gulp lint:es` Lint ES6 files using eslint.
115179
- `gulp lint:js` Lint Javascript files using jshint.
116180
- `gulp clean` Clean out distribution javascript files.

0 commit comments

Comments
 (0)