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.

Sign up for GitHub

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

Jump to bottom

Create README w/ Documentation, Links & Acknowledgments #667

Open
10 of 12 tasks
dmccoystephenson opened this issue Jun 14, 2024 · 0 comments · May be fixed by #668
Open
10 of 12 tasks

Create README w/ Documentation, Links & Acknowledgments #667

dmccoystephenson opened this issue Jun 14, 2024 · 0 comments · May be fixed by #668
Assignees
@dmccoystephenson
Milestone
v2.5.0

Comments

@dmccoystephenson
Copy link

dmccoystephenson commented Jun 14, 2024 •
edited
Loading

Description
As a member of the RPKit community, I’d like to see all the important information about the plugin when I load the GitHub repository. A README should be created that should include useful links, instructions on how to compile the project, acknowledgments, and other relevant details.

Acceptance Criteria

  • README created
  • Description of plugin added to README
  • Quick links added to README
  • Support section added to README
  • Installation section added to README
  • Compiling the Project section added to README
  • Contributing section added to README
  • Acknowledgments section added to README
  • License section added to README
  • Table of Contents added to README
  • PR opened to merge changes into development branch
  • changes merged
@dmccoystephenson dmccoystephenson changed the title Create README with Documentation and Contributor Recognition Create README with Links & Acknowledgments Jun 14, 2024
@dmccoystephenson dmccoystephenson self-assigned this Jun 14, 2024
@dmccoystephenson dmccoystephenson changed the title Create README with Links & Acknowledgments Create README w/ Documentation, Links & Acknowledgments Jun 14, 2024
@dmccoystephenson dmccoystephenson linked a pull request Jun 14, 2024 that will close this issue
Added README #668
Open
@dmccoystephenson dmccoystephenson added this to the v2.5.0 milestone Jun 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dmccoystephenson dmccoystephenson

Labels
None yet
Projects
None yet
Milestone
v2.5.0
Development

Successfully merging a pull request may close this issue.

Added README RP-Kit/RPKit
1 participant
@dmccoystephenson