c0dewordsky/realmate

Participate in Hacktoberfest by contributing to any Open Source project on GitHub! Here is a starter project for first time contributors. #hacktoberfest

Hacktoberfest 2023 ✅ | RealMate

How to Contribute to this project

1. Local Development
2. Gitpod

*** Please read this before submitting a pull request! Guideline ***

Local Development

1. Fork the repository first (Click the Fork button in the top right of this page, click your Profile Image)
2. Clone the forked repository to your local machine.

git clone https://github.com/your-username/devvsakib/Hacktoberfest2023.git

3. change the present working directory

cd Hacktoberfest2023

4. Open CMD in your current directory and install npm packages using command.

npm install / yarn

5. Run the project.

npm run dev / yarn dev

5. Make changes in the project. Add, Commit and Push the project using following commands:

Create a Branch

git checkout -b <name of the branch>

• Make the changes

Add all files

git add .

Commit the changes

git commit -m "Write Your commit Message"

Push the branch

git push

OR

git push origin branch-name

Make Pull Request from Github Repository ** Star the repository. **

Gitpod

In the cloud-free development environment which will have all the dependencies you need (for example MongoDB).

You can use Gitpod in the cloud to directly contribute to the project without cloning to your local system and any installation of dependencies(Gitpod does that all by itself).

Adding Projects

If you want to add your project in repository, you are welcome. Please add your project in "PROJECTS" folder and make sure to name your folder as your project.
Ex:
we have a react projects in "PROJECTS" folder
and we named it "clone-tesla"

So, people will know what project it is. Make sure you added your github name and link as comment in your file. Last thing to do is, put your name. github link, email in CONTRIBUTORS.md file

NOTE

• Make Sure you commit your changes in a new branch.
• Make Sure you Give proper name to your files describing the addition.
• Also Make Sure you comment your code wherever necessary.
• Make sure the eslint Compiled successfully! doesn't show you a warning.

REPO STATUS

Size: 0.00 MiB

Event Occured

1. Hacktoberfest 2023 (Ongoing)

Support

Please leave a STAR⭐

Connect with us

Join Us

Thanks to all the contributors ❤️

Add your details in src/json/Contributors.json file and
Read this docs for generate your contributor card

Show some ❤️ by starring this awesome repository!