Skip to content

Latest commit

 

History

History
87 lines (53 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

87 lines (53 loc) · 2.75 KB
Raw

Thank you for your interest in contributing to devFind! Here's a guide to get you started on your exciting coding adventure! 🚀

Set up your environment

To embark on your devFind journey, you'll need a few tools. Make sure you have Node.js and Git installed on your computer. You can download Node.js from the official website. For Git, visit this link.

Once you have these in place, let's get the devFind repository onto your local machine. Fire up your terminal and run this command:

git clone https://github.com/shyamtawli/devFind.git

Install pnpm

To make things even more fun and efficient, we're using pnpm. Install it with this command:

npm install -g pnpm

Install dependencies

Time to gather our supplies! Navigate to the project folder in your terminal and install the dependencies with these magical incantations:

cd devFind
pnpm install

Launch the Application

Ready to unveil your creation? Use this command to start the application:

pnpm start

Create a New Branch

Now, before you unleash your creativity, let's create a new branch. This will be your canvas for crafting your masterpiece. Execute this command:

git checkout -b your-branch-name

Make Your Changes

The world of devFind is your oyster! Make your changes, tweak existing code, add dazzling new features, or zap those pesky bugs.

Test Your Changes

Before you reveal your wizardry, ensure everything works like a charm. Run the tests with this enchantment:

pnpm test

The tests will act as your trusty spellbook, guiding you to victory!

Commit Your Changes

You're ready to immortalize your work. Commit your changes to your local branch using this incantation:

git add .
git commit -m "Your magical commit message"

Push Your Changes

With your spells ready, it's time to share your magic with the world. Push your changes to your remote branch:

git push origin your-branch-name

Create a Pull Request

Your masterpiece is ready for the world to see! Navigate to the devFind repository on GitHub, and with a flourish, click the "New pull request" button. Follow the magical instructions to create your pull request.

Participate in Code Reviews

Your spellbinding creation will be reviewed by fellow wizards and witches to ensure it meets the project's high standards. Be ready to cast additional spells or address any mystical feedback provided.

Merge Your Changes

When your pull request is blessed by the council of wizards and passes all tests, it can be merged into the main codebase. Congratulations, you've successfully left your mark on devFind! 🪄🔮✨