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

Amend the project README #10

Open
swmcc opened this issue Feb 26, 2023 · 0 comments · Fixed by #24
Open

Amend the project README #10

swmcc opened this issue Feb 26, 2023 · 0 comments · Fixed by #24
Assignees
Labels
📚 documentation Improvements or additions to documentation

Comments

@swmcc
Copy link
Owner

swmcc commented Feb 26, 2023

As a developer, I want to amend the README file for my project so that other developers can easily understand what the project does and how to use it.

As a user, I want to be able to quickly find the installation and usage instructions for the project, as well as any dependencies or prerequisites that are needed.

As a contributor, I want to be able to see information on how to contribute to the project, such as guidelines for submitting pull requests and any coding conventions or style guides that should be followed.

As a potential employer or collaborator, I want to be able to read a clear and concise summary of the project, including its purpose, features, and any notable achievements or awards. This will help me assess whether the project aligns with my goals and interests, and whether I would be a good fit for the team working on it.

@swmcc swmcc added the 📚 documentation Improvements or additions to documentation label Feb 26, 2023
@swmcc swmcc self-assigned this Feb 28, 2023
@swmcc swmcc linked a pull request Apr 11, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 documentation Improvements or additions to documentation
Projects
Development

Successfully merging a pull request may close this issue.

1 participant