Skip to content

Commit a226a6e

Browse files
committed
(docs) Add Contributing guide
1 parent 87555d4 commit a226a6e

File tree

2 files changed

+69
-5
lines changed

2 files changed

+69
-5
lines changed

CONTRIBUTING.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Contributing to baguetteBox.js
2+
3+
Please read these guidelines before contributing code.
4+
5+
## :nut_and_bolt: Setting up the development environment
6+
- Fork and clone the repository
7+
- `npm install`
8+
- `npm start`
9+
- Demo page with live reload is available at `localhost:3000`
10+
11+
## :bug: Fixing a Bug
12+
When fixing a bug please make sure to test it on as many browsers as possible (see: [Compatibility](./README.md#compatibility)). If you are not able to do so, mention that in a PR comment, so other contributors can do it.
13+
14+
## :tada: Proposing a Change
15+
When implementing a feature please create an issue first explaining your idea and asking whether there's need for such a feature.
16+
Remember the script's core philosophy is to stay simple and minimal, doing one thing and doing it right.
17+
18+
## :pencil: Before you open a Pull Request
19+
- Follow Git best practices (especially use meaningful commit messages).
20+
- Describe thoroughly you work in a PR comment.
21+
- Be patient and understanding. It's a side project, done in free time.
22+
23+
Thank you to everyone who has contributed to baguetteBox.js!
24+
25+
## :rocket: Releasing the next version
26+
27+
#### :heavy_exclamation_mark: This should be done only by core contributors :heavy_exclamation_mark:
28+
29+
Build the script
30+
```sh
31+
gulp build
32+
git add --updated
33+
git commit -m "Build update"
34+
```
35+
36+
Bump the version
37+
```sh
38+
gulp release # or gulp patch
39+
git add --updated
40+
git commit -m "v1.8.0"
41+
```
42+
43+
Push changes
44+
```sh
45+
git push
46+
```
47+
48+
Add a tag
49+
```sh
50+
git tag v1.8.0
51+
git push --tags
52+
```
53+
54+
Deploy the new demo page
55+
```sh
56+
gulp deploy
57+
cd ./publish
58+
git push
59+
```
60+
61+
Publish the new version to `npm`
62+
```sh
63+
npm publish
64+
```

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Simple and easy to use lightbox script.
1515
## Features
1616

1717
* Written in pure JavaScript, no dependencies required
18-
* Multiple-gallery support, allows custom options for each
18+
* Multiple-gallery support allows custom options for each
1919
* Supports swipe gestures on touch-screen devices
20-
* Full screen mode available
20+
* Full-screen mode available
2121
* Modern and minimal look
2222
* Image captions support
2323
* Responsive images
@@ -158,16 +158,16 @@ If you have 1366x768 resolution baguetteBox.js will choose `"img/medium/2-1.jpg"
158158
* Opera 12+
159159
* Safari 5+
160160

161-
## Notes
161+
## Contributing
162162

163-
Feel free to report any issues!
163+
Feel free to report any issues! If you wish to contribute by fixing a bug or implementing a new feature, please first see [CONTRIBUTING](./CONTRIBUTING.md).
164164

165165
## Credits
166166

167167
Creation of `baguetteBox.js` was inspired by a great jQuery plugin [touchTouch](https://github.com/martinaglv/touchTouch).
168168

169169
## License
170170

171-
Copyright (c) 2016 [feimosi](https://github.com/feimosi/)
171+
Copyright (c) 2017 [feimosi](https://github.com/feimosi/)
172172

173173
This content is released under the [MIT License](https://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)