Adds environment setup instructions #56
Conversation
There was a problem hiding this comment.
@mahakbansal2019, can you please place it as descriptive link just like everywhere else in the document (example here is in Contributing section).
You can add it as a new section in between Contributing and Branches.
|
@Menina294 and @mahakbansal2019, I should've labelled this issue a |
|
@mtreacy002 |
README.md
Outdated
| @@ -11,6 +11,10 @@ This is the backend client of Bridge-In-Tech. | |||
|
|
|||
| Please read our [Contributing Guidelines](.github/CONTRIBUTING.md), [Code of Conduct](.github/CODE_OF_CONDUCT.md) and [Reporting Guidelines](.github/REPORTING_GUIDELINES.md) thoroughly. | |||
|
|
|||
| **BridgeInTech Environment Setup Instructions** | |||
|
|
|||
| https://github.com/anitab-org/bridge-in-tech-backend/wiki/BIT-development-environment-setup | |||
There was a problem hiding this comment.
It's good that you have now placed it in a separate section @mahakbansal2019. However, instead of showing it as http url, can you mask it with a descriptive link (like the one in Contributing section) perhaps say something like...
"To start contributing to the project, setup the backend environment on your local machine by following the instructions on the BIT Development Environment Setup Instruction wiki page"
(on the bold words you can place that url link to wiki). Does this make sense?
There was a problem hiding this comment.
Okay!
Will make the desired changes :)
| @@ -11,6 +11,9 @@ This is the backend client of Bridge-In-Tech. | |||
|
|
|||
| Please read our [Contributing Guidelines](.github/CONTRIBUTING.md), [Code of Conduct](.github/CODE_OF_CONDUCT.md) and [Reporting Guidelines](.github/REPORTING_GUIDELINES.md) thoroughly. | |||
|
|
|||
| ## Setup | |||
| To start contributing to the project, setup the backend environment on your local machine by following the instructions on the [BIT Development Environment Setup Instruction]( https://github.com/anitab-org/bridge-in-tech-backend/wiki/BIT-development-environment-setup) wiki page. | |||
|
|
|||
There was a problem hiding this comment.
This looks good now, @mahakbansal2019. I'm happy to approve this. We just need to wait for one more reviewer to approve the PR before it can be merged. cc @anitab-org/coding-team or @anitab-org/bridgeintech-maintainers .
Thanks again for your contribution and patience in responding to each requested changes 😉
* Added environment setup instructions * Added a descriptive link
* Added environment setup instructions * Added a descriptive link
Description
Add link to environment setup instructions in README.md
Fixes #55
Type of Change:
Code/Quality Assurance Only
Checklist: