DOC: Add open-source contribution docs and issue templates - #21
Merged
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Overview
Adds the docs a project needs to take outside contributions in a structured way: a
CONTRIBUTING.md, a CHANGELOG.md, GitHub issue templates, and an updated PR template.
Ticket(s)
N/A
Links(s)
N/A
Example(s)
blank box.
"discuss before you code" flow described in CONTRIBUTING.md.
Dependencies
None.
Design
of input is welcome right now (bug reports, design feedback, questions), and the bar for
hosting an official language port (a real sum type with compiler-enforced exhaustiveness).
Includes a language candidate table (TypeScript, Scala, Rust, others) as a starting reference.
1.0.0and the1.0.1OMITTEDwording fix,using the standard Keep a Changelog format.
bug_report.mdandfeature_request.mdunder.github/ISSUE_TEMPLATE/, both scoped to the same simple, structured format.Notes to the end so it reads as a closing thought rather than a mid-template detour.
github.com/slatekit/...togithub.com/kiitdev/..., ahead of a planned GitHub org rename to match thekiit.devdomain.The live CI badge and
build.gradle.kts's SCM metadata were deliberately left asslatekitfor now, since those would actually break today, they'll get updated once the org rename
itself happens.
Notes
This mirrors the same docs already added to kiit-result, keeping both repos' contribution flow
consistent.
Pending
The
slatekitreference in the CI badge andbuild.gradle.kts'sscmblock is intentionallyunchanged, tracked as follow-up once the GitHub org is actually renamed.
Tests
None, docs only.