Skip to content

Commit 0f3174a

Browse files
committed
Readme: Add advice about dist/ and git-fu
[skip-ci]
1 parent dad8d7a commit 0f3174a

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,10 +85,15 @@ grunt --plugins=remove_button,restore_on_backspace
8585
```
8686

8787
### Contributing
88+
When issuing a pull request:
8889

89-
When issuing a pull request, *please exclude changes in the "dist"
90-
folder to avoid merge conflicts*. Please include tests with your feature
91-
so that we're not tempted to break it in the future!
90+
* please **do not include/commit changes in the `dist/` folder** to avoid
91+
merge conflicts. A good way to include the right files is to use
92+
`git gui` or `git add` when committing to select the files you want to
93+
add to your commit.
94+
95+
* please **include tests** with your feature so that we're not tempted to
96+
break it in the future!
9297

9398
Add an entry to the top of the CHANGELOG, and update the documentation
9499
in `docs/` as needed. (Refactors and documentation changes don't need a
@@ -99,6 +104,13 @@ with a concise and descriptive message. One commit means one
99104
feature/bugfix/thing that has changed, or a diff bringing the code one
100105
step forward to a better, working state.
101106

107+
Once your commit is nice and clean, and you want to *discard the other
108+
changes*, you can use `git checkout .` (that will erase changes to
109+
tracked files) and `git clean [-i/--interactive]` (to erase untracked
110+
files). **However, be careful with those commands, as their function
111+
is to erase things/changes.**
112+
113+
102114
#### Tests
103115
Please ensure all the tests pass:
104116

@@ -118,6 +130,10 @@ $ grunt serve
118130

119131
You can then run the examples in `http://localhost:8000/examples/`.
120132

133+
However, be careful not to add the `dist/` files in your commit, as
134+
Grunt automatically regenerates the files in `dist/` as the source is
135+
changed.
136+
121137
## License
122138

123139
Copyright © 2013–2016 [Brian Reavis](http://twitter.com/brianreavis) & [Contributors](https://github.com/selectize/selectize.js/graphs/contributors)

0 commit comments

Comments
 (0)