* Add/Remove accept a name rather than a path (same behavior).
* [API] Remove AddWatch on Windows, use Add.
* [internal] use syscall constants directly for inotify and kqueue.
-* [internal] kqueue: rename events to kevents and fileEvent to event
+* [internal] kqueue: rename events to kevents and fileEvent to event.
## v0.12.0 / 2014-06-19
## v0.10.0 / 2014-05-23
-* [API] Remove current implementation of WatchFlags [#1](https://github.com/nathany/fsnotify/pull/1)
+* [API] Remove current implementation of WatchFlags.
## v0.9.0 / 2014-01-17
[#25]: https://github.com/howeyc/fsnotify/issues/25
[#24]: https://github.com/howeyc/fsnotify/issues/24
[#21]: https://github.com/howeyc/fsnotify/issues/21
-[#1]: https://github.com/howeyc/fsnotify/issues/1
+
# Contributing
-### Moving Notice
+Send questions to [golang-dev@googlegroups.com](mailto:golang-dev@googlegroups.com). Request features and report bugs using the [GitHub Issue Tracker](https://github.com/fsnotify/fsnotify/issues).
-We plan to include os/fsnotify in the Go standard library with a new [API](http://goo.gl/MrYxyA).
-
-* Import `code.google.com/p/go.exp/fsnotify` ([GoDoc](http://godoc.org/code.google.com/p/go.exp/fsnotify)) for the latest API under development.
-* Continue importing `github.com/howeyc/fsnotify` ([GoDoc](http://godoc.org/github.com/howeyc/fsnotify)) for the stable API.
-* [Report Issues](https://code.google.com/p/go/issues/list?q=fsnotify) to go.exp/fsnotify after testing against `code.google.com/p/go.exp/fsnotify`
-* Join [golang-dev](https://groups.google.com/forum/#!forum/golang-dev) to discuss fsnotify.
-* See the [Contribution Guidelines](http://golang.org/doc/contribute.html) for Go and sign the CLA.
+A future version of Go will have [fsnotify in the standard library](https://code.google.com/p/go/issues/detail?id=4068), therefore fsnotify carries the same [LICENSE](https://github.com/fsnotify/fsnotify/blob/master/LICENSE) as Go. Contributors retain their copyright, so we need you to fill out a short form before we can accept your contribution: [Google Individual Contributor License Agreement](https://developers.google.com/open-source/cla/individual).
### Pull Requests
To hack on fsnotify:
-1. Install as usual (`go get -u github.com/nathany/fsnotify`)
+1. Install as usual (`go get -u github.com/fsnotify/fsnotify`)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Ensure everything works and the tests pass (see below)
4. Commit your changes (`git commit -am 'Add some feature'`)
3. Push to the branch (`git push fork my-new-feature`)
4. Create a new Pull Request on GitHub
-For other team members:
+If other team members need your patch before I merge it:
-1. Install as usual (`go get -u github.com/nathany/fsnotify`)
+1. Install as usual (`go get -u github.com/fsnotify/fsnotify`)
2. Add your remote (`git remote add fork git@github.com:mycompany/repo.git`)
3. Pull your revisions (`git fetch fork; git checkout -b my-new-feature fork/my-new-feature`)
-Notice: Always use the original import path by installing with `go get`.
+Notice: For smooth sailing, always use the original import path. Installing with `go get` makes this easy.
### Testing
-fsnotify uses build tags to compile different code on Linux, BSD, OS X, and Windows. Our continuous integration server is only able to test on Linux at this time.
+fsnotify uses build tags to compile different code on Linux, BSD, OS X, and Windows.
Before doing a pull request, please do your best to test your changes on multiple platforms, and list which platforms you were able/unable to test on.
-To make cross-platform testing easier, we've created a Vagrantfile for Linux and BSD.
+To make cross-platform testing easier, I've created a Vagrantfile for Linux and BSD.
* Install [Vagrant](http://www.vagrantup.com/) and [VirtualBox](https://www.virtualbox.org/)
* Setup [Vagrant Gopher](https://github.com/nathany/vagrant-gopher) in your `src` folder.
* Run `vagrant up` from the project folder. You can also setup just one box with `vagrant up linux` or `vagrant up bsd` (note: the BSD box doesn't support Windows hosts at this time, and NFS may prompt for your host OS password)
-* Once setup, you can run the test suite on a given OS with a single command `vagrant ssh linux -c 'cd nathany/fsnotify; go test ./...'`.
-* When you're done, you will want to halt or destroy the vagrant boxes.
+* Once setup, you can run the test suite on a given OS with a single command `vagrant ssh linux -c 'cd fsnotify/fsnotify; go test'`.
+* When you're done, you will want to halt or destroy the Vagrant boxes.
-Notice: fsnotify file system events won't work on shared folders. The tests get around this limitation by using a tmp directory, but it is something to be aware of when logging in with `vagrant ssh linux` to do some manual testing.
+Notice: fsnotify file system events don't work on shared folders. The tests get around this limitation by using a tmp directory, but it is something to be aware of.
-Right now we don't have an equivalent solution for Windows and OS X, but there are Windows VMs [freely available from Microsoft](http://www.modern.ie/en-us/virtualization-tools#downloads).
+Right now I don't have an equivalent solution for Windows and OS X, but there are Windows VMs [freely available from Microsoft](http://www.modern.ie/en-us/virtualization-tools#downloads).
# File system notifications for Go
-[](http://gocover.io/github.com/nathany/fsnotify) [](http://godoc.org/github.com/nathany/fsnotify)
+[](http://gocover.io/github.com/fsnotify/fsnotify) [](http://godoc.org/github.com/fsnotify/fsnotify)
-Cross platform, works on:
-* Windows
-* Linux
-* BSD
-* OSX
+Cross platform: Windows, Linux, BSD and OS X.
-### Moving Notice
+Please see [the documentation]((http://godoc.org/github.com/fsnotify/fsnotify)) for usage.
-We plan to include os/fsnotify in the Go standard library with a new [API](http://goo.gl/MrYxyA).
+## API stability
-* Import `code.google.com/p/go.exp/fsnotify` ([GoDoc](http://godoc.org/code.google.com/p/go.exp/fsnotify)) for the latest API under development.
-* Continue importing `github.com/howeyc/fsnotify` ([GoDoc](http://godoc.org/github.com/howeyc/fsnotify)) for the stable API.
-* [Report Issues](https://code.google.com/p/go/issues/list?q=fsnotify) to go.exp/fsnotify after testing against `code.google.com/p/go.exp/fsnotify`
-* Join [golang-dev](https://groups.google.com/forum/#!forum/golang-dev) to discuss fsnotify.
-* See the [Contribution Guidelines](http://golang.org/doc/contribute.html) for Go and sign the CLA.
+The fsnotify API has changed from what exists at `github.com/howeyc/fsnotify` ([GoDoc](http://godoc.org/github.com/howeyc/fsnotify)).
+Further changes are expected. You may use [gopkg.in](https://gopkg.in/fsnotify/fsnotify.v0) to lock to the current API:
+
+```go
+import "gopkg.in/fsnotify/fsnotify.v0"
+```
+
+A new major revision will be tagged when the API changes.
+
+## Contributing
+
+Send questions to [golang-dev@googlegroups.com](mailto:golang-dev@googlegroups.com). Request features and report bugs using the [GitHub Issue Tracker](https://github.com/fsnotify/fsnotify/issues).
+
+A future version of Go will have [fsnotify in the standard library](https://code.google.com/p/go/issues/detail?id=4068), therefore fsnotify carries the same [LICENSE](https://github.com/fsnotify/fsnotify/blob/master/LICENSE) as Go. Contributors retain their copyright, so we need you to fill out a short form before we can accept your contribution: [Google Individual Contributor License Agreement](https://developers.google.com/open-source/cla/individual).
+
+Please read [CONTRIBUTING](https://github.com/fsnotify/fsnotify/blob/master/CONTRIBUTING.md) before opening a pull request.
projects / fsnotify.git / commitdiff