Skip to content

Latest commit

 

History

History
31 lines (24 loc) · 3.24 KB

contributing.md

File metadata and controls

31 lines (24 loc) · 3.24 KB
Raw

What do I need to know to help?

If you are looking to help with a code contribution, our project uses React. If you don't feel ready to make a code contribution yet, no problem! There may be some open issues related to documentation or design soon so we recommend that you watch the repo to get notified when there are new activities happening on the project. You can also propose improvements by opening a new issue.

How do I make a contribution?

Never made an open source contribution before? Wondering how contributions work in our project? Here's a quick rundown!

  1. Fork the repository to your account. This means that you will have a copy of the repository under your-GitHub-username/repository-name.
  2. Clone the repository to your local machine using git clone https://github.com/github-username/repository-name.git.
  3. Create a new branch for your fix using git checkout -b branch-name-here.
  4. Open the project in a code editor and navigate to the members.js file. The path within the project is Open-source-unizik\src\utils\members.js. 1.Read the comment in the top of the file and follow the instructions.
  5. Setup the project in your local by following the steps listed in the readme file
  6. Use git add . to add the contents of the changed files to the "snapshot" git uses to manage the state of the project, also known as the index.
  7. Use git commit -m "Insert a short message of the changes made here" to store the contents of the index with a descriptive message.
  8. Push the changes to the remote repository using git push origin branch-name-here.
  9. Submit a pull request to the upstream repository.
  10. Title the pull request with a short description of the changes you made . For example, you can title an issue like so "Added John Doe to the project". In the description of the pull request, be sure to explain the changes that you made and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it!
  11. Wait for the pull request to be reviewed by a maintainer.
  12. Make changes to the pull request if the reviewing maintainer recommends them.
  13. Celebrate your success after your pull request is merged! 🎉

Where can I go for help?

  • If you need help, you can ask questions directly in the pull request or issue.

What does the Code of Conduct mean for me?

  • Our Code of Conduct means that you are responsible for treating everyone on the project with respect and courtesy regardless of their identity. If you are the victim of any inappropriate behavior or comments as described in our Code of Conduct, we are here for you and will do the best to ensure that the abuser is reprimanded appropriately, per our code.

Portions of this contributing.md file are based off of Safia Abdalla's template for creating open source contributor guidelines