Thanks for your interest in contributing! ❤️
The easiest way you can help is to sponsor me on Github. If you just want to have an impact on jank and you're not sure what else to do, see if you can chip in $10/month.
If you like jank, but just don't have time to contribute, that's ok! There are other easy ways to support jank and show your appreciation:
- Star the repo on Github
- Tweet/toot/chat about it
- Mention jank at your local meetups and tell your friends/colleagues
Otherwise, work your way through this list and see what may be a good match for you.
- If you want to build something cool with jank, do it!
- Please host your jank projects on Github and share them with the community
- If you know C++, you can pick up an unassigned issue with the
help-wantedtag here: https://github.com/jank-lang/jank/issues - If you know Clojure, you can check out the clojure-test-suite repo, where we're organizing a suite of unit tests for all core Clojure functions
- If you're familiar with distro packaging, we can often use help with deb/rpm/arch/nix packages
- If you're a Clojurists Together member, please vote for my proposals
- Either way, consider joining the jank community on Slack and chat
This project, and everyone participating, in it is governed by the jank Code of Conduct. By participating, you are expected to uphold this code.
Overall, the #jank Slack channel is the best place to ask questions to the community. If you can't/won't use Slack, Github Discussions is the next best place to ask.
Please use jank's Github Discussions forum for reporting bugs. Before creating a new discussion, please search for an existing discussion on your topic and use that if it exists. Do not just create an issue.
Once you're ready to share your changes with use for review and merge consideration, please make a pull request on Github. Add a description of your change to your pull request, as well as a descriptive title.
To convey that your pull request is ready for review, please add me (jeaye) as a reviewer. I will then review your pull request when I am next available.
After review, I may request iteration on your pull request. If you iterate and you're ready for review again, please add me as a reviewer again in order to request another review. Github emails me with every change you push, but I cannot know which one is final. A request for review is unambiguous.
Note that every commit in your PR is required to be signed with an identity trusted by your Github account. Without this, the PR will not be mergeable. For information on how to set this up, see this guide.
All external contributions must exclusively be created by humans. Content, including code and copy, generated by a large language model or similar technology will not be accepted. As a jank contributor, you are responsible and accountable for your contributions. Contributing to jank means vouching for the quality, license compliance, and utility of your submission.
Certain policies, such as AI assistance, only apply to external contributors. By default, every contributor to jank is an external contributor. Internal contributor status is granted to those with a proven, trusted history of contributing to jank, and a proven understanding its goals and design philosophies.
Concerns about possible policy violations should be reported via email to conduct@jank-lang.org.