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

Updated readme.md #15

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,30 @@
## Links
[Figma](https://www.figma.com/file/vytKlKFg74ypSj6haevygK/Sunbird-RC-for-Hacktoberfest?node-id=0%3A1)

[Issues](https://github.com/Sunbird-RC/vc-issuance/issues)

[Swagger UI](https://sbrc-swagger.tiiny.site)

[Discussions](https://github.com/Sunbird-RC/vc-issuance/discussions)

## 🏍 To use , view or run the code :

<img src="https://media.giphy.com/media/kdiLau77NE9Z8vxGSO/giphy.gif" width="40%"><br>

* Clone / Download :

git clone https://github.com/your_username_/Project-Name.git
Copy link
Member

Choose a reason for hiding this comment

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

you can add the actual url of the project

Copy link
Author

Choose a reason for hiding this comment

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

Hey , if I put the actual url of the project , wouldn't it be wrong for the guy who wants to contribute

There are the scenarios :

  1. If a guy needs to only see the project then [ git clone actual url ] works
  2. But if the guy needs to contribute , he first needs to fork and due to that the url of the project will change to
    git clone https://github.com/your_username_/Project-Name.git

Copy link
Author

Choose a reason for hiding this comment

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

@tejash-jl Any update

* Open the project in your favorite code editor and do following to install the necessary dependencies

npm install


## ✍ Contributing :
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

* Fork the Project
* Create your new Branch <code> git checkout -b NewBranchName </code>
* Commit your Changes <code> git commit -m " Description of contribution you made " </code>
* Push to the Branch <code> git push origin NewBranchName </code>
* Open a Pull Request with description <code>fixes #(issue_link)</code>

[Design System](https://www.figma.com/file/j0Rl8R0xVKMko2EzxPW3rE/Sunbird-RC-Design-System?node-id=59%3A296)