feat: improve project documentation, configuration and code comments - #4
Open
Dark-Brain07 wants to merge 10 commits into
Open
feat: improve project documentation, configuration and code comments#4Dark-Brain07 wants to merge 10 commits into
Dark-Brain07 wants to merge 10 commits into
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.
Summary
This PR creates a comprehensive improvement to the project's documentation and configuration standards.
Changes
package.jsonwith relevant keywords..gitignoreto exclude common editor and log files.CONTRIBUTING.mdto guide new contributors.PULL_REQUEST_TEMPLATE.mdto standardize PRs.SECURITY.mdto define security policies.README.md.@noticedocumentation to key functions inVelo.sol,Minter.sol,Voter.sol, andVotingEscrow.sol.Motivation
These changes improve the onboarding experience for new developers and ensure better code maintainability and standard compliance.