docs: Initialize README.md file. about bridge-in-tech-backend

[menina763]

Alrighty, I managed to submit my first PR! It wasn't as scary as I thought it would be 😅. Could you please check it and make sure that I submitted it right?

[menina763]

Alrighty, thanks @mtreacy002 !

[menina763]

Alrighty, I finished typing the README.md file. Should I add it here?

[menina763]

Alrighty, I think due to my internet downloading VSCode will take a while, but in the meantime I'll try to follow along with the tutorials you linked. Thanks for helping me out by the way, and I'll reach out again if I need some assistance 😄!

[menina763]

Hello! Could I perhaps take on this issue?

[mayburgos]

@Menina294 Yes! Go ahead and feel free to ping @mtreacy002 for a proper description. I couldn't come up with one. :)

[menina763]

Alrighty!
@mtreacy002 , do you happen to know what I should include for the description?
Wait, should I ping in Zulip?

[mtreacy002]

Thanks, for taking up the issue, @Menina294. you're officially the first contributor to the project 🎉.
I can answer here (or reach me out on Zulip bridge-in-tech stream if I take some time to answer here, coz browsing emails not as easy as browsing Zulip, I guess 😂 ). I have a brief info on the project proposal that you can put as an overview of the project. I also have another 'brief- er' version of the project on my blog intro.
Feel free to play with the wordings as long as its inline with the spirit of the project 😉.
Let me know if you need further assistance 😃.

[mtreacy002]

For setting up, I will have to wait for the meeting with mentors first to finalise the platform and architecture. But will keep you updated on Zulip bridge-in-tech stream on this 😉

[mtreacy002]

Alrighty, I finished typing the README.md file. Should I add it here?

Definitely, @Menina294. You can open a PR to address this issue, so we (both of us and other contributors) can review it together 😉 . Let me know if you need some help 👍

[menina763]

Yeah, I think I might need some help with opening a PR since I've never done that before 😅

[mtreacy002]

No worries, @Menina294. I'm here to help 😉

So, on the top navbar you could click on Pull requests

click on the New Pull Request button (green one on the left)

then pls copy paste the Pull request template to the body of the repo.

### Description

<!--- Include a summary of the change and relevant motivation/context. List any dependencies that are required for this change. --->

Fixes # [ISSUE]

### Type of Change:

<!--- **Delete irrelevant options.** --->

- Code
- Quality Assurance
- User Interface
- Outreach
- Documentation

**Code/Quality Assurance Only**
- Bug fix (non-breaking change which fixes an issue)
- This change requires a documentation update (software upgrade on readme file)
- New feature (non-breaking change which adds functionality pre-approved by mentors)



### How Has This Been Tested?

<!-- Describe the tests you ran to verify your changes. Provide instructions or GIFs so we can reproduce. List any relevant details for your test. -->


### Checklist:

<!-- **Delete irrelevant options.** -->

- [ ] My PR follows the style guidelines of this project
- [ ] I have performed a self-review of my own code or materials
- [ ] I have commented my code or provided relevant documentation, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] Any dependent changes have been merged
- [ ] Update Postman API at /docs folder
- [ ] Update Swagger documentation and the exported file at /docs folder
- [ ] Update requirements.txt

**Code/Quality Assurance Only**

- [ ] My changes generate no new warnings 
- [ ] My PR currently breaks something (fix or feature that would cause existing functionality to not work as expected)
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been published in downstream modules

[mtreacy002]

on Fixes # [ISSUE], replace '# [ISSUE]' with the issue number you are working on (in this case' #1'

[mtreacy002]

For the title of the PR, please follow the commit guidelines here to choose the right message you should use as the commit message.
As for the PR title, I normally use the format: : <#Issue number> . Keep the description short and concise, possibly no longer than 35 characters long?

[menina763]

Hmm, when I clicked on the "New Pull Request" button, I was taken to a Comparing page. Did I click somewhere wrong?

[mtreacy002]

Sorry, my bad, I forgot to ask, have you commit your code changes and push to the remote repository from your IDE?

[mtreacy002]

I can guide you if you're not sure how to

[menina763]

Nope, I haven't done that yet, and yes I would appreciate it if you would guide me!

[mtreacy002]

Nope, I haven't done that yet, and yes I would appreciate it if you would guide me!

Cool.. Can you tell me which IDE you are using, pls?

[menina763]

I don't know if it counts as an IDE, but I was using a extension on Google Chrome called "Markdown Editor"

[mtreacy002]

Also, can you please tell me what's the step you take when cloning this repository? Have you fork this repo and open it on an IDE?

[menina763]

No, I was too afraid to clone it or fork it 😅

[mtreacy002]

It's ok, one step at a time. I felt like that too when I was a beginner...😂

But then I found out, cloning won't create any damage to your system. Same concept actually used for copy pasting. We never have to worry about the impact. 😆
Anyway, you could put this issue on hold for now (we're in no hurry) and try this GitHub guidelines/tutorial first to get use to the forking, cloning and contributing to the repository. I did this too for when I first trying to contribute to open source. I found this resource is very helpful. Still, don't hesitate to ask me on anything if you have doubt 😉

[mtreacy002]

Also, don't forget to save the file you've already work on in a .md format so it's ready to be used once you know and have cloned this repo to your IDE. I'll help you along until you're comfortable finding your way around GitHub 😉

[mtreacy002]

Just curious, which IDE you're thinking of working on for this repo? I'm using VSCode, but everyone can use whichever IDE they preferred

[menina763]

I haven't used any IDE's in a loong time, so I guess I'll try VSCode. Hopefully it doesn't take too long to download!

[mtreacy002]

It shouldn't be. I'm not sure how long it'll take to download (I did that a while ago), but it'll a good alternative to have among all other great IDE out there. So, it'll be worth it. 😀

[mtreacy002]

Alrighty, I think due to my internet downloading VSCode will take a while, but in the meantime I'll try to follow along with the tutorials you linked. Thanks for helping me out by the way, and I'll reach out again if I need some assistance 😄!

Will be here for you .... see you later 👋

[mtreacy002]

Alrighty, I managed to submit my first PR! It wasn't as scary as I thought it would be 😅. Could you please check it and make sure that I submitted it right?

Well done, @Menina294. I'm proud of you for taking the first step for contributing to open source 🚀 💃🥰. I'll review your PR and give you my feedback there 😉 .