docs: add CONTRIBUTING.md and issue/PR templates (#13)#64
Open
koteshyelamati wants to merge 4 commits into
Open
docs: add CONTRIBUTING.md and issue/PR templates (#13)#64koteshyelamati wants to merge 4 commits into
koteshyelamati wants to merge 4 commits into
Conversation
Added a comprehensive contributing guide for the OrbitChain project, detailing setup, development workflow, commit message conventions, and security considerations.
Added a bug report template for issue tracking.
Added a feature request template for GitHub issues.
Add a pull request template for contributors to follow.
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.
Completes the remaining community-health files from #13.
SECURITY.mdalready landed in #16; this PR adds the rest of the acceptance criteria:CONTRIBUTING.md— environment setup (Rust toolchain + Soroban CLI), workspace layout including thecampaign/canonical-contract rule, themakebuild/test/fmt/lint/audit/deny workflow, Conventional Commits, the PR process, and a security section that points toSECURITY.md..github/ISSUE_TEMPLATE/bug_report.md— structured bug report (affected component, repro steps, environment)..github/ISSUE_TEMPLATE/feature_request.md— feature request template..github/PULL_REQUEST_TEMPLATE.md— PR checklist mirroring the localmakechecks and Conventional Commits.All content is derived from the existing README and Makefile so the instructions match the repo's actual tooling. This is a docs-only change — no code paths are touched.