diff options
| author | Sean Allred <code@seanallred.com> | 2014-12-02 20:16:36 -0500 |
|---|---|---|
| committer | Sean Allred <code@seanallred.com> | 2014-12-02 20:16:36 -0500 |
| commit | 539debfc6c07b1cd9bf478452869f36583877eca (patch) | |
| tree | 204ef78ea987b121e31a55511c512aff0ad66746 | |
| parent | a0556c38eb39d66fcde2a7e09eaa9f1ed7e3a7e6 (diff) | |
Add CONTRIBUTING.org
| -rw-r--r-- | CONTRIBUTING.org | 23 | ||||
| -rw-r--r-- | README.org | 4 |
2 files changed, 26 insertions, 1 deletions
diff --git a/CONTRIBUTING.org b/CONTRIBUTING.org new file mode 100644 index 0000000..46fcf13 --- /dev/null +++ b/CONTRIBUTING.org @@ -0,0 +1,23 @@ +If you need help, search the issue tracker to see if anyone has asked +your question before. If it hasn't, a good place to ask first is our +chat room on [[https://gitter.im/vermiculus/sx.el][Gitter]]. Opening an issue is welcome of course, but chat +will likely be faster for you. If a code change needs to be made, an +issue can be written up as necessary. + +Have a great idea for SX? Again, discuss it on [[https://gitter.im/vermiculus/sx.el][Gitter]] first! Don't +limit ideas to mimicking the official website, either -- this is +Emacs; we should take advantage of its abilities. + +To see what we're working on /right now/, check out our [[http://www.waffle.io/vermiculus/sx.el][Waffle board]]. +If you would like to contribute, feel free to take on anything in the +=ready= column (which translates to the =ready= label in GitHub +issues). These are issues which have been discussed enough to provide +a good idea of what should be done. Issues in =backlog= are either +still under discussion or simply are in the backlog. + +Of course, the greatest gift you can give to SX is a good word. Star +the project on GitHub, mention it to others who would use it in your +StackExchange chat rooms (as always, be courteous and respectful), and +use it yourself. + +Enjoy! @@ -48,7 +48,7 @@ authentication token to act on your behalf. Eventually, this package will be available on MELPA. * Contributing -Please help contribute! Doing any of the following will help us immensely: +Please help contribute! Doing any of the following will help us immensely: - [[https://github.com/vermiculus/sx.el/issues/new][Open an issue]] - [[https://github.com/vermiculus/sx.el/pulls][Submit a pull request]] - [[https://gitter.im/vermiculus/sx.el][Suggest a package or library in our Chat on Gitter]] (or just hang out =:)=) @@ -58,6 +58,8 @@ For a better view of all of the open issues, take a look at our lovely [[http:// board]]. Feel free to take the torch on anything in =backlog= or =ready=. If you have thoughts on any other issues, don't hesitate to chime in! +See also =CONTRIBUTING.org=. + * Resources - [[http://www.gnu.org/software/emacs/][GNU Emacs]] - [[https://api.stackexchange.com/docs][Stack Exchange API v2.2]] |