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

Added FAQs and resources #22

Conversation

PragatiVerma18
Copy link
Contributor

Description

Added FAQs and important resources for beginners and participants of GSSoC 2020.

Type of change

  • This change requires a documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented on my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • Any dependent changes have been merged and published in downstream modules

Reviewer: Vinit Shahdeo

@welcome
Copy link

welcome bot commented Feb 27, 2020

Thanks for opening this pull request!
Please add @vinitshahdeo as a reviewer if you haven't added.

Copy link
Owner

@vinitshahdeo vinitshahdeo left a comment

Choose a reason for hiding this comment

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

@PragatiVerma18 Added a few comments, please have a look. Rest LGTM.

README.md Outdated
### Important Resources:

<ul>
<li> Django Docs: https://docs.djangoproject.com/en/3.0/ </li>
Copy link
Owner

Choose a reason for hiding this comment

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

@PragatiVerma18 Open URLs look weird sometimes.
Can you please remove it?

[Django](some url) - > This will become a link. See this.

Use - .md syntax for creating lists. See this.

README.md Outdated
#### 2. Is this a hardware/IoT project?
Yes, it is a hardware/IoT + software project. There would be maximum tasks related to frontend, backend, design and documentation of the website and later, it would be integarted with the real-time data from the sensors.

#### 3.How to communicate with us?
Copy link
Owner

Choose a reason for hiding this comment

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

@PragatiVerma18 Missing whitespace between numbering and the first character of the question.

README.md Outdated
#### 3.How to communicate with us?
All communication will happen on the Slack channel for this particular projects. Mentors can also be reached through GitHub. Avoid DMs and unnecessary mentions on slack and GitHub both. Checkout this issue for more: <a href="https://github.com/vinitshahdeo/Water-Monitoring-System/issues/15">https://github.com/vinitshahdeo/Water-Monitoring-System/issues/15</a>

#### 4.What is the Tech Stack for this project?
Copy link
Owner

Choose a reason for hiding this comment

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

@PragatiVerma18 Missing whitespace between numbering and the first character of the question.

README.md Outdated
All communication will happen on the Slack channel for this particular projects. Mentors can also be reached through GitHub. Avoid DMs and unnecessary mentions on slack and GitHub both. Checkout this issue for more: <a href="https://github.com/vinitshahdeo/Water-Monitoring-System/issues/15">https://github.com/vinitshahdeo/Water-Monitoring-System/issues/15</a>

#### 4.What is the Tech Stack for this project?
<strong>Frontend:</strong> ReactJS<br>
Copy link
Owner

Choose a reason for hiding this comment

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

Let's use .md syntax only. Check this.

Copy link
Owner

@vinitshahdeo vinitshahdeo left a comment

Choose a reason for hiding this comment

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

Great job @PragatiVerma18 👏

@vinitshahdeo vinitshahdeo merged commit 78bfcaa into vinitshahdeo:feature/documentation Feb 27, 2020
@welcome
Copy link

welcome bot commented Feb 27, 2020

Congrats on merging your first pull request! 🙌🎉⚡️
Show some love by starring a few of my repositories.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants