Thank you for your interest in contributing to devFind! Here is a guide to help you get started:
To contribute to devFind, you will need to have Node.js and Git installed on your computer. You can download Node.js from the official website. Git can be downloaded from here.
Once you have installed these dependencies, you can clone the devFind repository to your local machine by running the following command in your terminal:
git clone https://github.com/shyamtawli/devFind.git
To install pnpm use this command.
npm install -g pnpm
Navigate to the project folder on your terminal and install the dependencies using:
pnpm install
Run the following command to start the application:
pnpm start
Before you start making changes, create a new branch to work on. This helps keep your changes separate from the main codebase, making it easier to manage and review your contributions later.
You can create a new branch using the following command:
git checkout -b your-branch-name
Now that you have set up your environment and created a new branch, you can start making your changes. You can modify existing code, add new features or fix bugs.
Before submitting your changes, it is important to test them thoroughly to make sure they work as expected. Run the following command to test the application:
pnpm test
This will run all the tests in the project and give you feedback on any failures.
Once you have tested your changes, you can commit them to your local branch using the following command:
git add .
git commit -m "Your commit message"
After committing your changes, you can push them to your remote branch using the following command:
git push origin your-branch-name
Now that your changes are pushed to your remote branch, you can create a pull request to merge your changes into the main codebase. Navigate to the devFind repository on GitHub and click the "New pull request" button. Follow the instructions to create your pull request.
Your pull request will be reviewed by other contributors to ensure it meets the project's standards and does not introduce any bugs or security vulnerabilities. Be prepared to make additional changes or address any feedback that is given.
Once your pull request is approved and passes all tests, it can be merged into the main codebase. Congratulations, you have successfully contributed to devFind!