chore(docs): added other essential open source documentation files #245
Conversation
This file contains 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
- Added `CONTRIBUTING.md` with development and PR guidelines - Added `CODE_OF_CONDUCT.md` based on Contributor Covenant - Added `SECURITY.md` with vulnerability reporting process - Added issue and PR templates - Updated `README.md` with documentation references and fixed lint errors - Updated `.gitignore` file to ignore VSCode workspace settings
amjedidiah
changed the title
BSalaeddin
reviewed
Nov 22, 2024
.github/ISSUE_TEMPLATE/bug_report.md
Outdated
There was a problem hiding this comment.
Suggestion:
I believe it would be helpful to include a field where the reporter can specify the exact version or commit hash of the project they are reporting on. This will make it easier to identify and address version-specific issues accurately.
There was a problem hiding this comment.
Thanks @BSalaeddin, done
BSalaeddin
reviewed
Nov 22, 2024
README.md
Outdated
|  | ||
|
|
||
| <br/> | ||
| An open-source, free-to-use NPM component that easily handles your file upload needs with seamless DigitalOcean Spaces, Amazon S3, Google Drive and OneDrive integration. |
There was a problem hiding this comment.
Suggestion:
Given that the package relies on JSX and React hooks, it would be more precise to describe it as a "React component library" rather than a generic "NPM component," ensuring the description aligns with its core technology stack.
There was a problem hiding this comment.
Thanks @BSalaeddin , done
- updated README to describe package as a "React component library" rather than a generic "NPM component," ensuring the description aligns with its core technology stack - included field for commit hash in bug report
BSalaeddin
approved these changes
Nov 26, 2024
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.
CONTRIBUTING.mdwith development and PR guidelinesCODE_OF_CONDUCT.mdbased on Contributor CovenantSECURITY.mdwith vulnerability reporting processREADME.mdwith documentation references and fixed lint errors.gitignorefile to ignore VSCode workspace settings