Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
100 lines (69 loc) · 4.8 KB

CONTRIBUTING.md

File metadata and controls

100 lines (69 loc) · 4.8 KB

Here's the revised CONTRIBUTING.md file with your requested changes and improvements for clarity and consistency:

Contributing Guidelines 📄

This documentation contains a set of guidelines to help you during the contribution process. We welcome all contributions from anyone willing to improve or add new features 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 the basics of Git and GitHub, and also contact the Project Mentors if you need help:


Issue Report Process 📌

  1. Go to the project's issues page.
  2. Provide a proper description of the issue.
  3. Avoid spamming to get the assignment of the issue.
  4. Wait until someone assigns the issue to you.
  5. Start working on the issue only after it has been assigned to you.

Set-Up and Installation:

To get started with contributing to TechBytes, follow these steps:

  1. Clone the repository: Fork the repository and then clone it to your local machine

    git clone https://github.com/singhJasvinder101/MyBlog.git

  2. Change the directory to Client and Install required Packages:

    cd client
npm install

  3. Make Your Changes: Make the necessary modifications or additions to the project files.

  4. Commit and Push: Once you've made your changes, commit them and push to your fork:

    git add .
git commit -m "Describe your changes here"
git push

  5. Create a Pull Request: Navigate back to the original repository and open a pull request from your forked repository.

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 TechBytes repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
    • Choose the MyBlog 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 TechBytes 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 TechBytes repository.

Pull Request Process 🚀

  1. Ensure that you have self-reviewed your code.
  2. Make sure you have added a proper description for the functionality of the code.
  3. Comment your code, particularly in hard-to-understand areas.
  4. Add screenshots if they help in the review.
  5. Submit your PR by providing the necessary information in the PR template. Hang tight; we will review it really soon!

Thank you for contributing 💗