Instructions for contribution

Contributing.md

@@ -0,0 +1,28 @@
+# Publishing a new version
+
+- [ ]  Pick an appropriate incremented version number v0.x.y (e.g. 0.4.0 becomes 0.4.1 or 0.5.0 depending on how much changed)
+- [ ]  Update the `History.md` file to reflect all changes that will be in the new version. If you've been keeping it up to date (and it appears you have), this just involves inserting the above version number below vNEXT.
+- [ ]  Update this version number in `package.js`.
+- [ ]  git commit (but don't push yet).
+- [ ]  Try `meteor publish`
+- [ ]  If everything worked, `git tag v0.x.y` and push the tag (`git push origin v0.x.y`; this allows others to find the code for this version) and merge into master and push that too. (If you aren't rebasing the feature branch you may want to merge first before publishing)
+- [ ] If publishing didn't work, you can fix things, amend the commit as necessary, then tag and push after verifying that it went through.
+
+In order to `meteor publish`, you will need to be added as a maintainer to this package. You can see a list of the current maintainers with:
+
+```
+meteor admin maintainers mizzao:user-status --list
+```
+
+# Travis CI
+
+To be written.
+
+See https://travis-ci.org/Meteor-Community-Packages/meteor-user-status
+
+# Pushing a demo
+
+To be written.
+
+We host the demo at https://user-status.meteorapp.com.
+

README.md

@@ -194,3 +194,7 @@ Check out https://github.com/mizzao/meteor-accounts-testing for a simple account
 ## Testing
 
 There are some `Tinytest` unit tests that are used to test the logic in this package, but general testing with many users and connections is hard. Hence, we have set up a demo app (http://user-status.meteor.com) for testing that is also hosted as a proof of concept. If you think you've found a bug in the package, try to replicate it on the demo app and post an issue with steps to reproduce.
+
+## Contributing
+
+See [Contributing.md](Contributing.md).