Skip to content

Commit

Permalink
Add CONTRIBUTING.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
fukamachi committed Dec 16, 2015
1 parent 1faf836 commit a970d2c
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 0 deletions.
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,35 @@
# Contributing to Clack

Clack is an open source project and we appreciate your help!

## Reporting bugs

Please [open an issue](https://github.com/fukamachi/clack/issues/new) at GitHub.

Good reports must include these informations:

- The full backtrace with your error
- Minimum steps to reproduce it
- Names and versions you are using: OS, Common Lisp implementation, ASDF and Quicklisp dist

You can get informations about your environment by this code:

```common-lisp
(flet ((put (k v &rest vs)
(format t "~&~A: ~A~{ ~A~}~%" k v vs)))
(put "Machine" (software-type) (software-version))
(put "Lisp" (lisp-implementation-type) (lisp-implementation-version)
#+(and sbcl (not sb-thread)) "(without threads)")
(put "ASDF" (asdf:asdf-version))
(let ((qlversion (ql:dist-version "quicklisp")))
(put "Quicklisp" qlversion
(if (string= (car (first (ql:available-dist-versions "quicklisp")))
qlversion)
"(latest)"
"(update available)"))))
;-> Machine: Darwin 15.2.0
; Lisp: SBCL 1.3.1
; ASDF: 3.1.5
; Quicklisp: 2015-10-31 (latest)
;=> NIL
```
4 changes: 4 additions & 0 deletions README.markdown
Expand Up @@ -59,6 +59,10 @@ When you execute `ros install clack`, it copies `clackup` script to `$HOME/.rosw
* [Toot](https://github.com/gigamonkey/toot)
* [Woo](https://github.com/fukamachi/woo)

## How to contribute

See [CONTRIBUTING.md](CONTRIBUTING.md).

## See Also

* [Lack](https://github.com/fukamachi/lack): Clack application builder
Expand Down

0 comments on commit a970d2c

Please sign in to comment.