docs: add CODE_OF_CONDUCT and CONTRIBUTING guidelines#28
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
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.
This pull request adds important documentation to the project by introducing a Code of Conduct and a Contributing Guide, and also updates the
README.mdfor clarity and accuracy. These changes help set clear expectations for community behavior, contribution workflow, and usage instructions, making it easier for new contributors to get started and for users to correctly integrate the library.New documentation:
CODE_OF_CONDUCT.mdfile based on Contributor Covenant 3.0, outlining community expectations, reporting procedures, and enforcement for a safe and inclusive environment.CONTRIBUTING.mdfile with guidelines on how to contribute, set up the project, run tests, submit pull requests, and follow the code of conduct.Improvements to usage instructions:
README.mdto use consistent double-quote imports in code examples, improving clarity for users integrating the library. [1] [2]npx twd-mocktonpx twd-js, ensuring users follow the correct setup process.README.mdfor readability and consistency. [1] [2]These updates enhance the project's accessibility, usability, and community standards.
This closes #27