Skip to content

Latest commit

 

History

History
188 lines (126 loc) · 6.82 KB

CONTRIBUTING.md

File metadata and controls

188 lines (126 loc) · 6.82 KB
Raw

Contributing Guidelines 📄

This documentation contains a set of guidelines to help you during the contribution process. We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. Thank you for helping out and remember, no contribution is too small.
Please note we have a code of conduct please follow it in all your interactions with the project.


Need some help regarding the basics?🤔

You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:


Project Structure

your-project-name/
│
├── src/                   # Source files
│   ├── scripts/           # JavaScript or Python scripts
│   ├── styles/            # CSS or SCSS files
│   ├── components/        # Reusable components (if using frameworks like React)
│   ├── assets/            # Images, fonts, and other static assets
│   └── index.html         # Main HTML file (if applicable)
│
├── tests/                 # Test files
│   ├── unit/              # Unit tests
│   └── integration/       # Integration tests
│
├── docs/                  # Documentation files
│   ├── CONTRIBUTING.md    # Contribution guidelines
│   ├── CODE_OF_CONDUCT.md # Code of conduct
│   └── README.md          # Project overview and setup instructions
│
├── .gitignore             # Files and directories to ignore in Git
├── package.json           # Project metadata and dependencies (if using Node.js)
├── requirements.txt       # Python dependencies (if applicable)
└── LICENSE                # License information for the project

Steps to Contribute Using the Command Line

  1. Fork the Repository:

Click on the "Fork" button on the top right of the repository page on GitHub to create your own copy of the repository.

  1. Clone the Repository: Open your terminal and run:
git clone https://github.com/your-username/repository-name.git
  1. Navigate to the Project Directory:
cd repository-name
  1. Create a New Branch: It's a good practice to create a new branch for your work.

Now Run:

git checkout -b your-branch-name

Replace your-branch-name with a meaningful name describing your changes.

  1. Make Your Changes: Open your code editor, make the necessary changes or add new features to the codebase.

  2. Stage and Commit Changes: Stage the files you've modified using:

git add .

Commit your changes with a descriptive message:

git commit -m "Add: meaningful description of your changes"
  1. Push Changes to GitHub: Push your branch to your forked repository:
git push origin your-branch-name
  1. Create a Pull Request:

-Go to your forked repository on GitHub. -Click on the "Compare & pull request" button. -Add a descriptive title and details about your changes. -Click on "Create pull request."

  1. Wait for Review: Your pull request will be reviewed by the project maintainers. If any changes are required, please make them and update your pull request accordingly.

Alternatively contribute using GitHub Desktop

  1. Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.

  2. Clone the Repository:

    • If you haven't cloned the repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
    • Choose the repository from the list of repositories on GitHub and clone it to your local machine.

  3. Switch to the Correct Branch:

    • Ensure you are on the branch that you want to submit a pull request for.
    • If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.

  4. Make Changes: Make your changes to the code or files in the repository using your preferred code editor.

  5. Commit Changes:

    • In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
    • Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to " button to commit your changes to the local branch.

  6. Push Changes to GitHub: After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.

  7. Create a Pull Request:

  • Go to the GitHub website and navigate to your fork of the repository.
  • You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.

  1. Review and Submit:

    • On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
    • Once you're satisfied, click the "Create pull request" button to submit your pull request.

  2. Wait for Review: Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the repository.


Pull Request Process 🚀

  1. Ensure that you have self reviewed your code 😀
  2. Make sure you have added the proper description for the functionality of the code
  3. I have commented my code, particularly in hard-to-understand areas.
  4. Add screenshot it help in review.
  5. Submit your PR by giving the necessary information in PR template and hang tight we will review it really soon 🚀

Issue Report Process 📌

  1. Go to the project's issues.
  2. Give proper description for the issues.
  3. Don't spam to get the assignment of the issue 😀.
  4. Wait for till someone is looking into it !.
  5. Start working on issue only after you got assigned that issue 🚀.

💬 Need Help

Admin :- Mani Kumar Reddy

Email: [email protected] Github Issues


Thank you for contributing💗

We truly appreciate your time and effort to help improve our project. Feel free to reach out if you have any questions or need guidance. Happy coding! 🚀