Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding contribution.md for contribution guidelines #173

Open
wants to merge 23 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
WELCOME TO OSCSA

OSCSA welcomes contributors from around the world that are interested in contributing to its repositries

CODE OF CONDUCTS

All contributors are required to read and abide by the code of conducts of OSCSA.
This is to ensure that the OSCSA environment is a safe working/contribution for all contributors
link: https://github.com/Open-Science-Community-Saudi-Arabia/Open-Science-Community-in-Saudi/blob/main/CODE_OF_CONDUCT.md

HOW TO CONTRIBUTE TO OSCSA WEBSITE

The OSCSA website is the official website for the OSCSA community
The website was built with
- HTML
- CSS
- JAVASCRIPT
- PHP

Contribution can either be technical or non-technical, so dont be worried if you have no coding knowledge.

STEPS TO CONTRIBUTE

- Start by forking and cloning the OSCSA website repository
link : https://github.com/Open-Science-Community-Saudi-Arabia/OSCSA_Website

- Now open the cloned repo in your IDE (e.g VsCode)

- Create a new branch
link on how to create a new branch: https://www.freecodecamp.org/news/how-to-create-a-local-git-branch/

- Open the index.html file then use the shortcut [shift+alt+b] to see the website in your browser

- Go through the website and think of ways that you can contribute to the website
i.e

- Working on an issues by mentors
- Correcting a typographical error
- Creating new features
- Fixing a bug
- Writng content e.t.c

- Now that you know what you what you want to work on, create an issue on GitHub tagging one of the mentors, and also make
sure that issue has not been assigned or suggested to/by another contributor

- Now that you've contributed, push your code to your branch, then make a pull request

link: how to make a pull request :https://www.freecodecamp.org/news/how-to-make-your-first-pull-request-on-github-3/

- While describing your pull request, make sure to add the issue number you are working on
e.g fixes #24

- Describe the problem you are solving
- List the areas you've corrected
- Then create a pull request (PR)

- Wait for it to be reviewed and merged
- Congrats on your first contribution 🎉 .

HURRAY!!!!