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

Improve ReadME to Make More Useful to New Contributors #71

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve ReadME to Make More Useful to New Contributors #71

wants to merge 2 commits into from

Conversation

oliviab321
Copy link

Pull Request Template

Description

Improve README to make more useful for new contributors by:

  • Adding additional detailed project setup steps
  • Add Project Structure Description (for both backend and frontend) to introduce new contributors to project
  • Update PR guidelines to include template
  • Update table of contents accordingly with new changes

Type of change

Documentation Update

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have checked my code and corrected any misspellings

@oliviab321
Improve ReadME
eaa08a0 
Add additional detailed project setup steps, project structure description (for both backend and frontend), and update PR guidelines. Update table of contents accordingly.
@oliviab321
Update README.md
45a7294 
Update table of contents
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@oliviab321