diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..c3408469c9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +# Contributing to Athens + +These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. + +Please first read the [Code of Conduct](https://github.com/tangjeff0/athens/blob/master/CODE_OF_CONDUCT.md). + +## Development Environment + +See the setup in the README. + +## Clojure + +Will probably setup [clj-kondo](https://github.com/borkdude/clj-kondo) with some config as a project linter. + +## Git Commit Messages + +Follow suggestions in https://www.conventionalcommits.org/en/v1.0.0/. + +## Issues and PRs + +Follow suggestions in https://github.com/codeforamerica/howto/blob/master/Good-GitHub-Issues.md + +Still don't have labels or really any issues yet. Working on it! :)