[KLC-1914] docs: add comprehensive community and project documentation#8
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR establishes comprehensive open-source documentation to support community collaboration and project onboarding for the Klever blockchain. It introduces four essential documentation files following industry standards and blockchain-specific best practices.
Key changes:
- Security policy with vulnerability reporting process, severity classification, and bug bounty program details
- Contribution guidelines covering Go coding standards, testing requirements, commit conventions, and PR workflow
- Code of conduct based on Contributor Covenant 2.1 with blockchain-specific ethical guidelines
- Comprehensive README with installation instructions, quick start guide, and links to official documentation
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| SECURITY.md | Establishes security vulnerability reporting procedures, severity classifications, response timelines, and responsible disclosure guidelines |
| README.md | Provides project overview, installation steps, build instructions, usage examples, and resource links |
| CONTRIBUTING.md | Defines contribution workflow, Go coding standards, testing guidelines, commit message format, and PR process |
| CODE_OF_CONDUCT.md | Sets community standards based on Contributor Covenant 2.1 with blockchain-specific guidelines for security and network testing |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
phcarneirobc
left a comment
phcarneirobc
left a comment
Contributor
There was a problem hiding this comment.
Maybe it’s worth adding to the README how to run the node using make or make runsctrace
Add essential documentation files to support open-source collaboration and project onboarding: - SECURITY.md: Security policy with vulnerability reporting guidelines, severity classification, and responsible disclosure practices - CONTRIBUTING.md: Detailed contribution guidelines including Go coding standards, testing requirements, commit message format, and PR process - CODE_OF_CONDUCT.md: Contributor Covenant 2.1 with blockchain-specific guidelines for responsible disclosure and network testing ethics - README.md: Comprehensive project overview with installation, build instructions, quick start guide, and links to official documentation Key improvements: - Aligned with industry standards from major blockchain projects - Includes blockchain-specific security considerations - References actual Makefile targets (make goimports, make test) - Points to official documentation at docs.klever.org - Fixed community resource links (kleverscan.org, forum.klever.org) - Removed inaccurate technical details to prevent documentation drift
fbsobreira
force-pushed
the
docs/add-community-documentation
branch
from
2234eeb to
2cda06d
Compare
nickgs1337
requested changes
Oct 27, 2025
Add standardized templates to streamline issue reporting and pull request submissions: - .github/ISSUE_TEMPLATE/bug_report.md: Template for bug reports with environment details, reproduction steps, and blockchain-specific context (node type, network, configuration) - .github/ISSUE_TEMPLATE/feature_request.md: Template for feature requests with impact assessment, use cases, and implementation considerations (consensus impact, breaking changes, performance) - .github/ISSUE_TEMPLATE/config.yml: Issue template configuration with helpful links to docs, forum, and security reporting - .github/PULL_REQUEST_TEMPLATE.md: Comprehensive PR template matching successful PR patterns in the project (Summary/Problem/Solution format) CONTRIBUTING.md improvements: - Updated Go version requirement to reference go.mod as source of truth - Fixed interface naming convention examples (agent nouns pattern) - Added explicit rebase-only policy for conflict resolution - Updated PR template section to reference actual template file
- Add help target with auto-generated documentation - Add clean target to remove build artifacts - Fix FOR_TESTNET/FOR_DEV variable assignments - Fix ENV_FLAG quotes issue - Add help comments to all major targets
phcarneirobc
approved these changes
Oct 28, 2025
fbsobreira
changed the title
nickgs1337
approved these changes
Oct 29, 2025
fbsobreira
added a commit
that referenced
this pull request
Nov 4, 2025
#8) * docs: add comprehensive community and project documentation Add essential documentation files to support open-source collaboration and project onboarding: - SECURITY.md: Security policy with vulnerability reporting guidelines, severity classification, and responsible disclosure practices - CONTRIBUTING.md: Detailed contribution guidelines including Go coding standards, testing requirements, commit message format, and PR process - CODE_OF_CONDUCT.md: Contributor Covenant 2.1 with blockchain-specific guidelines for responsible disclosure and network testing ethics - README.md: Comprehensive project overview with installation, build instructions, quick start guide, and links to official documentation Key improvements: - Aligned with industry standards from major blockchain projects - Includes blockchain-specific security considerations - References actual Makefile targets (make goimports, make test) - Points to official documentation at docs.klever.org - Fixed community resource links (kleverscan.org, forum.klever.org) - Removed inaccurate technical details to prevent documentation drift * docs: add GitHub issue and PR templates for better contributions Add standardized templates to streamline issue reporting and pull request submissions: - .github/ISSUE_TEMPLATE/bug_report.md: Template for bug reports with environment details, reproduction steps, and blockchain-specific context (node type, network, configuration) - .github/ISSUE_TEMPLATE/feature_request.md: Template for feature requests with impact assessment, use cases, and implementation considerations (consensus impact, breaking changes, performance) - .github/ISSUE_TEMPLATE/config.yml: Issue template configuration with helpful links to docs, forum, and security reporting - .github/PULL_REQUEST_TEMPLATE.md: Comprehensive PR template matching successful PR patterns in the project (Summary/Problem/Solution format) CONTRIBUTING.md improvements: - Updated Go version requirement to reference go.mod as source of truth - Fixed interface naming convention examples (agent nouns pattern) - Added explicit rebase-only policy for conflict resolution - Updated PR template section to reference actual template file * chore(makefile): add help target and fix variable syntax - Add help target with auto-generated documentation - Add clean target to remove build artifacts - Fix FOR_TESTNET/FOR_DEV variable assignments - Fix ENV_FLAG quotes issue - Add help comments to all major targets * chore(docs): replace @klever.io with @klever.org across docs, CLIs and app metadata
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.
Add essential documentation files to support open-source collaboration and project onboarding:
Key improvements: