docs: enhance project documentation and governance files#10891
Closed
adityashirsatrao007 wants to merge 2 commits intoNativeScript:mainfrom
adityashirsatrao007:main
Closed
docs: enhance project documentation and governance files#10891adityashirsatrao007 wants to merge 2 commits intoNativeScript:mainfrom adityashirsatrao007:main
adityashirsatrao007 wants to merge 2 commits intoNativeScript:mainfrom
adityashirsatrao007:main
Conversation
Add comprehensive documentation to improve contributor experience and project governance: - Add SECURITY.md with vulnerability reporting guidelines and security best practices - Add CONTRIBUTING.md at root level for easier discovery with detailed contribution workflow - Add MAINTAINERS.md with release process, triage guidelines, and community management procedures - Add CHANGELOG.md as central changelog index pointing to package-specific changelogs - Add .github/FUNDING.yml to enable GitHub Sponsors button - Add documentation issue template for better docs feedback Improve .gitignore: - Add common IDE patterns (.history, code-workspace files) - Add environment variable patterns (.env files) - Add additional temporary file patterns - Add package manager cache directories - Add OS-specific patterns for better cross-platform support - Add diagnostic report patterns - Organize sections with clear comments Update README.md: - Update contributing guide link to point to root-level CONTRIBUTING.md These changes follow industry best practices for open source projects and align with OpenJS Foundation standards. All documentation is written in clear, accessible language to welcome contributors of all experience levels.
…ocumentation docs: enhance project documentation and governance files
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.
Description
This PR significantly enhances the project's documentation and governance structure to improve the contributor experience and align with OpenJS Foundation best practices.
Changes Made
New Documentation Files
SECURITY.md
CONTRIBUTING.md (Root Level)
tools/notes/to root for better discoverabilityMAINTAINERS.md
CHANGELOG.md
.github/FUNDING.yml
Documentation Issue Template
.github/ISSUE_TEMPLATE/documentation.yamlEnhanced Files
.gitignore
README.md
Benefits
✅ Improved Discoverability: Critical files like CONTRIBUTING.md are now at root level
✅ Better Security: Clear vulnerability reporting process protects users and project
✅ Enhanced Governance: Maintainer guidelines ensure consistency across the team
✅ Welcoming to Contributors: Comprehensive guides lower barriers to entry
✅ Professional Standards: Aligns with OpenJS Foundation and industry best practices
✅ Better Git Hygiene: Enhanced .gitignore prevents accidental commits
Documentation Quality
All documentation has been carefully written to be:
Testing
Related Issues
This PR addresses the following improvement areas:
Checklist
Additional Context
These enhancements were made following a thorough analysis of the repository structure and industry best practices for open-source projects. The changes are designed to scale with the project as it grows and to make NativeScript more welcoming to new contributors while maintaining high standards.
The documentation structure now matches what contributors expect to find in mature, well-maintained open-source projects, which should improve community engagement and contribution quality.
Looking forward to your feedback! 🎉