Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update README and PR template #43

Merged

Conversation

derianrddev
Copy link
Contributor

πŸ“ Update README Installation Section and PR Template

πŸ› οΈ Issue

πŸ“– Description

  • This pull request fixes the incorrect Installation section in the README and adds a section in the PR template to request screenshots or videos to aid in the review process.

βœ… Changes made

  • Corrected the Installation section in the README.
  • Added a new section in the PR template asking for screenshots or videos to support the review process.

πŸ–ΌοΈ Media (screenshots/videos)

  • Preview Installation section README
    image
  • Preview Pull Request Template
    image

πŸ“œ Additional Notes

  • The updated Installation section now includes the correct steps for setting up the project.
  • The PR template has been modified to ensure visual evidence (screenshots or videos) for better clarity during the review process.

@danielcdz danielcdz added the enhancement New feature or request label Dec 7, 2024
@danielcdz danielcdz merged commit 3962365 into KaizeNodeLabs:main Dec 7, 2024
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update README and PULL REQUEST TEMPLATE
2 participants