Skip to content

Latest commit

 

History

History
119 lines (96 loc) · 4.79 KB

CONTRIBUTING.md

File metadata and controls

119 lines (96 loc) · 4.79 KB

Table of Contents

  1. Contributor Guidelines for Markdown-Previewer
  2. Assigning an Issue
  3. Contribution Process
    1. Star ⭐ the repository
    2. Fork the repository
    3. Cloning this repository
    4. Creating a New Branch
    5. Navigate to the project directory
    6. Add a reference(remote) to the original repository
    7. Check the remotes for this repository
    8. Always take a pull from the upstream repository to your master branch
    9. Create a new branch
    10. Track your changes
    11. Commit your changes
    12. Merge changes from master into your branch
    13. Push the committed changes in your feature branch to your remote repo
    14. Creating a Pull Request (PR)
    15. Code Review
    16. Merging
    17. Congratulations! 🎊

Contributor Guidelines for Markdown-Previewer

Thank you for your interest in contributing to Markdown-Previewer as part of Hacktoberfest! We greatly appreciate your contributions and want to ensure a smooth and efficient collaboration process. To maintain a structured workflow, please follow the guidelines outlined below.

Assigning an Issue

  • Before you start working on any feature or bug fix 🐞, check the Issues section to find a task or issue that interests you.
  • If you find an issue you'd like to work on, please comment on the issue for assigning process. This will help avoid duplication of effort and let others know that you are actively working on it. Please do not raise PR or start working on the issue before assigned to you.

Contribution Process:-

1. Star ⭐ the repository

  • First of all start this repository.

2. Fork the repository

  • Then fork the repository.

3. Cloning this repository

  • If you haven't already, fork the Markdown-Previewer repository to your GitHub account.
  • Clone your forked repository to your local development environment:
git clone https://github.com/your-username/Markdown-Previewer.git

4. Creating a New Branch

  • It's a good practice to create a new branch for each feature or bug fix you're working on. Use a descriptive name for your branch:
git checkout -b feature/your-feature-name

5. Navigate to the project directory.

cd Markdown-Previewer

6. Add a reference(remote) to the original repository.

git remote add upstream https://github.com/hirentimbadiya/Markdown-Previewer.git

7. Check the remotes for this repository.

git remote -v

8. Always take a pull from the upstream repository to your master branch to keep it at par with the main project (updated repository)..

git pull upstream master

9. Create a new branch.

git checkout -b username/issue_number

10. Track your changes.

git add .

11. Commit your changes.

git commit -m "<commit subject>"

12. While you are working on your branch, other developers may update the master branch with their branch. This action means your branch is now out of date with the master branch and missing content. So to fetch the new changes, follow along:

git checkout master
git fetch origin master
git merge upstream/master
git push origin

Now you need to merge the master branch into your branch. This can be done in the following way:

git checkout <your_branch_name>
git merge master

13. Push the committed changes in your feature branch to your remote repo.

git push -u origin <your_branch_name>

14. Creating a Pull Request (PR)

  • Go to your forked repository on GitHub, and you should see a button to create a Pull Request. Click on it.
  • Ensure your PR title and description are informative, describing the changes you made and referencing the issue if applicable.
  • Submit the PR.

15. Code Review

  • Our maintainers and other contributors will review your PR. Be prepared to make changes or address feedback as necessary.

16. Merging

  • Once your PR is approved and passes any required checks, it will be merged into the main repository.

17. Congratulations! 🎊

  • You've successfully contributed to Markdown-Previewer. Thank you for your valuable contribution.