Skip to content

Latest commit

 

History

History
59 lines (34 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

59 lines (34 loc) · 1.88 KB
Raw

Contributing Guidelines:

We welcome all contributions to the Open Science Community in Saudi Arabia. The contribution can be a issue report or a pull request.

Contribution workflow:

  1. Check that there isn't already an issue about your idea to avoid duplicating work.

    • If there isn't one already, please create one so that others know you're working on this

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

  3. Clone the forked repository on your local machine.

git clone https://github.com/<your-github-username>/Open-Science-Community-in-Saudi.git
  1. Sync the fork, to avoid merge conflicts.
    git remote add upstream https://github.com/Open-Science-Community-Saudi-Arabia/Open-Science-Community-in-Saudi.git
    git fetch upstream
    git pull upstream master
    git push
  1. Create a new branch with your github username as its name.
   git checkout -b <your-github-username>

  1. Make the necessary changes / additions within your forked repository.

  2. Add and commit changes made.

   git add .
   git commit -m "commit message"
  1. Push the changes to forked repository.
   git push origin <branch-name>
  1. Submit a Pull Request against the master branch and wait for the code to be reviewed and merged.

If you're not used to this workflow with git, you can start with some basic docs from GitHub.