Skip to content

Improve README with guidance for first-time contributors #1218

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.

Sign up for GitHub

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

Open
subwaycookiecrunch wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve README with guidance for first-time contributors #1218

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 14 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@
1. [CodeLabz](#codelabz)
2. [Deployment](#deployment)
3. [Community](#community)
4. [Contribute](#contribute)
5. [FAQs (Frequently Asked Questions)](#faqs)
4. [Getting Started for First-Time Contributors](#getting-started-for-first-time-contributors)
5. [Contribute](#contribute)
6. [FAQs (Frequently Asked Questions)](#faqs)

# CodeLabz

**CodeLabz** is a platform where the users can engage with online tutorials and the organizations can create tutorials for the users. The platform will be developed using ReactJS frontend library and the backend will be developed using the Google Cloud Firestore and Google Firebase Real-Time database.
**CodeLabz** is a platform where users can engage with online tutorials and the organizations can create tutorials for the users. The platform will be developed using ReactJS frontend library and the backend will be developed using the Google Cloud Firestore and Google Firebase Real-Time database.

# Deployment

Expand All @@ -20,6 +21,15 @@ Join and communicate with other members on our community. We communicate on gitt

[![Gitter](https://badges.gitter.im/scorelab/CodeLabz.svg)](https://gitter.im/scorelab/CodeLabz?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

# Getting Started for First-Time Contributors

This section is intended for contributors who are new to open source.

1. Start by reading the entire README to understand the project and its purpose.
2. Follow the setup instructions carefully to run the project locally.
3. If you face any issues, check existing issues to see if they have already been discussed.
4. If something is unclear, feel free to open a new issue and ask for guidance.

# Contribute

Contributions are always welcome!
Expand Down Expand Up @@ -104,4 +114,4 @@ Follow this link to fix this issue.
3. If you want to work on a new issue, first try to discuss it in the gitter channel with the mentors and then raise the issue.
<hr/>

### ❓ Got more questions, ask it in our [gitter channel](https://matrix.to/#/#scorelab_CodeLabz:gitter.im) and we will love ❤ to answer them.
### ❓ Got more questions, ask it in our [gitter channel](https://matrix.to/#/#scorelab_CodeLabz:gitter.im) and we will be happy to help.