Issue 2147: update README and contributing documents#2148
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
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.
connects #2147
This pull request introduces several important documentation files and updates to improve project clarity, onboarding, and community standards for the VERIFI repository. The main changes include the addition of a Code of Conduct, a coding style guide, and comprehensive contributing guidelines. The
README.mdhas also been significantly restructured and expanded to provide better information for both users and developers.New community and contribution documentation:
CODE_OF_CONDUCT.mdfile, establishing clear standards for behavior and enforcement procedures based on the Contributor Covenant.CONTRIBUTING.mdfile detailing how to get started, issue tracking, repository branching strategy, pull request requirements, documentation standards, and release/versioning processes.CODING_STYLE.mdfile outlining TypeScript/Angular coding conventions, formatting, naming, testing, and git/PR best practices.README improvements:
README.mdto clarify the purpose of VERIFI, add project badges, provide clearer installation/build/test instructions, and include sections for both users and developers.README.md, explicitly stating the project is MIT licensed and linking to theLICENSEfile.