Skip to content

Latest commit

聽

History

History
104 lines (74 loc) 路 2.69 KB

CONTRIBUTING.md

File metadata and controls

104 lines (74 loc) 路 2.69 KB
Raw

馃獩 Want to contribute?

We welcome you to join us!

How to Contribute to this repository

  1. Fork the repository (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/free-hit.git
  1. change the present working directory
cd free-hit
  1. There are two ways to start your application
  • Using Docker Compose
    • Docker must be installed and running before proceeding.
    • This is the easiest way to start your application without downloading any dependencies that can alter your local versions.
    • Below command builds the docker image and starts the container where our app will be running on http://localhost:5173/
    docker compose up

  • Normal Installation

    • Open CMD in your current directory and install pnpm packages using command.[If pnpm is not installed, you can install it by clicking on this link to pnpm]
pnpm i

Run it locally using

pnpm start
  1. Add new tool :

    Go to src > DB > product.json & add your code

{
    productName: "< App_Name >",
    category: "remote | resume | tweet | ai | ethical | movies | extensions | tools",
    image: "< Image-Url >",
    link: "< Link_to_the_website >",
    description: "< Description of product >"
},
  • To ensure that your URLs are short, it is recommended to use bitly for URL shortening.
  • Description should not exceed 10-12 words
  1. Make changes in the project. Add, Commit and push the project using following commands:

Add all files

git add .

Commit the changes

git commit -m "Write Your commit Message"

Create a new branch

git branch -M <your-name>

Set upstream command to create a PR

git remote add upstream https://github.com/JasonDsouza212/free-hit.git

Push the branch

git push
  1. Create a new pull request from your forked repository (Click the New Pull Request button located at the top of your repo)

How to Create a PR

  1. After you push the changes you need to create a pull request and name the issue and mention the issue number, eg: chore: added tool #issuenumber
  2. The tags which can be used for url submission are as follows: fix: , feat: , docs: , test: , chore: , ci: , perf: , refactor: , revert: , style: , data:
  3. Put an x between the braces to select the keypoint and leave a space if you don't want to select it. eg: [x] I follow the contribution guidelines.
  4. Wait for your PR review and merge approval!
  5. Star this repository if you had fun contributing!