Skip to content

Latest commit

 

History

History
45 lines (27 loc) · 1.77 KB

Contributing.md

File metadata and controls

45 lines (27 loc) · 1.77 KB
Raw

Contributing to Open Source With Hasnain

Welcome to Open Source With Hasnain! We're excited to have you contribute to our open-source project. Before you get started, please take a moment to read through our contribution guidelines.

Getting Started

  1. Check for Issues: Take a look at our existing Issues or create a new issue if you find something that needs attention.

  2. Fork the Repository: First, fork our repository by clicking on the "Fork" button in the top right corner of this page. 🍴

  3. Create a Branch: Create a new branch for the issue you are working on. This helps us keep track of different contributions. 🌿

  4. Commit Your Work: Make your changes and commit them to your branch. 💾

  5. Create a Pull Request (PR): When you're ready to submit your contribution, create a Pull Request. Your PR will be reviewed, and feedback or suggestions for improvements will be provided by the community. 🚀

  6. Add Screenshots: If your contribution involves UI changes, please add screenshots or screen captures to your Pull Request. This helps us understand the impact of your changes. 🖼️

Running the Project Locally

To run the project on your local machine, follow these steps:

  1. Clone your forked repository to your machine:

    git clone https://github.com/<your-username>/Open-Source-With-Hasnain.git

  2. Navigate to the project directory

    cd Open-Source-With-Hasnain

  3. Install the required packages

    npm install

  4. Run Locally

    npm start