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

Update readme.md to include important info #90

Conversation

JulianaSau
Copy link
Contributor

@JulianaSau JulianaSau commented Oct 25, 2022

Summary

Fixes #70
Addresses #10

Updating README.md with more information about the project and repository and include information important to new contributors

List of changes proposed in this PR (pull-request)

  • Added a few badges to track stars, contributors, forks
  • Added the figma design link
  • Added the getting started section to enable new contributors to understand how to set up either the frontend or the backend for development

Screenshots

image
image
image
image
image
image
image

What should a reviewer concentrate their feedback on?

  • If anything should be added or removed
  • Everything looks ok?

@JulianaSau JulianaSau changed the base branch from main to dev_team2 October 25, 2022 21:30
@JulianaSau
Copy link
Contributor Author

Hey @sandygudie, please review my pr

README.md Outdated
- Any page you code has to be responsive.
- Write clear and concise commit messages.
- Always run `yarn` after pulling code from the upstream repository.
- Always, **Always** make pull requests to the **dev** branch, not the main branch. All pull requests to the main branch will not be merged.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welldone @JulianaSau
...."to the dev_team2 branch"...
please

README.md Outdated
Comment on lines 109 to 110

- Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Vite app default port is 5173, it does not open at 3000 (unless customized)

@JulianaSau
Copy link
Contributor Author

JulianaSau commented Oct 26, 2022

Thanks for the review. I've updated the pr with the requested changes and also updated the screenshots to reflect the new changes.

@sandygudie
Copy link
Member

@BatoolMM this is ready for merging
Also, Please, if it's possible; I would like to request merge privilege for the MOOCs Frontend development so that development could be much faster. Thanks

@BatoolMM
Copy link
Member

BatoolMM commented Nov 9, 2022

@all-contributors please add @sandygudie for mentoring

@allcontributors
Copy link
Contributor

@BatoolMM

I've put up a pull request to add @sandygudie! 🎉

@BatoolMM
Copy link
Member

BatoolMM commented Nov 9, 2022

Just saw this - you now have merge privileges for the MOOCs Frontend development.

@BatoolMM BatoolMM merged commit fafdd3c into Open-Science-Community-Saudi-Arabia:dev_team2 Nov 9, 2022
RealRichi3 pushed a commit to RealRichi3/MOOCs that referenced this pull request Feb 21, 2023
…aSau/feat/update-ReadMe

Update readme.md to include important info
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[21/10/2022]: Add a detailed README .md file to the dev_team2 branch
3 participants