Introduction

###Raising-pr

A pull request is a way for contributors to submit changes to a project maintained by others. The changes are proposed and then reviewed and potentially merged by the project maintainers. In this guide, we will walk you through the steps of making a pull request to the Open-Science-Community-Saudi-Arabia/JSquarto repository on GitHub.

Steps

  1. Find a feature or bug that you want to work on.

  2. Fork the Open-Science-Community-Saudi-Arabia/JSquarto repository to your GitHub account.

  3. Clone the forked repository on your local machine.

    git clone https://github.com/Open-Science-Community-Saudi-Arabia/JSquarto

  4. Sync the fork, to avoid merge conflicts.

    git remote add upstream https://github.com/Open-Science-Community-Saudi-Arabia/JSquarto 
git fetch upstream
git pull upstream main
git push

  5. Create a new branch with your GitHub username as its name.

    git checkout -b <your-github-username>

    It is not mandatory to name the new branch with your GitHub username, but it is a good practice to do so, as long as the name of the branch is clear and concise, you can name it whatever you want.

  6. Make your changes on this new branch.

  7. Commit your changes with a clear commit message.

    git add .
git commit -m "Clear and concise commit message"

  8. Push your changes to your forked repository.

    git push origin <your-github-username>

  9. Go to the Open-Science-Community-Saudi-Arabia/JSquarto repository on GitHub, and you should see a message suggesting to create a new pull request. Click on it.

  10. To raise the PR choose the PR template and fill it with the required information. The PR template is a set of questions that you need to answer to make it easier for the maintainers to review your pull request. you can find the PR template here

  11. Add a clear and concise title and description for your pull request, explaining the changes you made.

  12. Submit your pull request, and wait for the maintainers to review your changes.

Congratulations! You’ve just made a pull request to the Open-Science-Community-Saudi-Arabia/JSquarto repository.