Contribution guide #151
Merged
Contribution guide #151
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
joerdav
reviewed
Nov 6, 2025
CONTRIBUTING.md
Outdated
| We aim to support popular, stable, lightweight plain-text markup languages. Our priorities for language support: | ||
| - New languages should work as similar to the Markdown implementation as possible | ||
| - Users should be able to read and maintain tasks without writing excessive markup or understanding implicit behavior | ||
| - The implementer wants to actually maintain `xc` tasks using the new language (we won't add languages just to have them) |
Owner
There was a problem hiding this comment.
It would be nice if people bringing a new language are willing to maintain their implementation. However, I don't expect for people to maintain their language that they implement initially. Which sort of means 2 things:
- People can contribute language implementations without any strings attached (woo).
- However! I'll only accept languages that I think are ubiquitous enough that I'm willing to take the maintenance burden.
A good litmus test is probably - if github don't support the markup language, it is highly unlikely I'll accept the PR.
Contributor
Author
There was a problem hiding this comment.
I made a clarification here incorporating that link & info.
joerdav
approved these changes
Jan 5, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #66
Why?
Now that org-mode is supported, there's precedent for adding further languages. I thought to close the loop by adding a HOWTO for future language contributors, but there's no contribution guide yet, so I took a stab at that as well.
What?