Add documentation for public release readiness, including issue and p…#20
Merged
Conversation
…ull request templates, contribution guidelines, security policy, and changelog
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
1 participant
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.
This pull request prepares XCSKit for public release by adding essential documentation, contribution guidelines, and repository templates. It introduces a changelog, code of conduct, security policy, and issue and pull request templates, and updates the README and SRS to clarify public API status and contribution processes.
Repository and Documentation Updates:
CHANGELOG.mddocumenting all notable changes and establishing semantic versioning for the project.CONTRIBUTING.mdwith development setup, branching, pull request, requirements, testing, and style guidelines.CODE_OF_CONDUCT.mdoutlining expected and unacceptable behavior for contributors.SECURITY.mdwith instructions for reporting vulnerabilities and supported versions.README.mdwith installation instructions, requirements table, license section, and links to new documentation files. Clarified public API status and contribution starting points. [1] [2]Repository Templates:
.github/ISSUE_TEMPLATE/bug_report.mdand.github/ISSUE_TEMPLATE/feature_request.mdto standardize issue reporting for bugs and feature requests. [1] [2].github/PULL_REQUEST_TEMPLATE.mdto guide pull request submissions with checklists for type, requirements, and testing.Requirements and Specification Updates:
docs/SRS.mdto clarify public audience, status, and to include analytics in scope and product overview.These changes ensure the repository is ready for broader public use and contribution, with clear guidance and improved transparency.…ull request templates, contribution guidelines, security policy, and changelog