Skip to content

Latest commit

 

History

History
59 lines (34 loc) · 3.37 KB

CONTRIBUTING.md

File metadata and controls

59 lines (34 loc) · 3.37 KB

Contributing to Wikidata for Education: WikiCurricula Dashboard

Thank you for your interest in contributing to Wikidata for Education! We welcome contributions from developers, designers, educators, and anyone passionate about improving educational resources through Wikidata.

Getting Started

Follow these steps to contribute to this project:

  1. Create a GitHub account: If you don't already have a GitHub account, go to the GitHub website and sign up for a free account.

  2. Fork the Repository: Click the "Fork" button at the top right corner of the project repository to create your copy of the repository. This allows you to work on changes without affecting the main project.

  3. Clone Your Fork: After forking, navigate to your forked repository on GitHub. Click the green "Code" button, and then select either HTTPS or SSH to get the repository's URL. Copy the URL.

  4. Clone the Repository Locally: Open your terminal or command prompt and run the following command, replacing <repository-url> with the URL you copied:

    git clone <repository-url>

  5. Making Contributions :Now that you have the project set up on your local machine, you can start making contributions. Here's how you can contribute:

  6. Choose an Issue : Go to the Issues section of the project repository. Browse through the open issues and select one that you'd like to work on. If you don't find an existing issue that matches your contribution, you can create a new one.

  7. Create a Branch: Before you start working on an issue, create a new branch for your changes. Naming your branch in a descriptive and clear way can be helpful. You can use the following command to create a new branch:

   git checkout -b my-feature-branch

  1. Make Your Changes: Write your code, documentation, or any other contribution in the branch you created. Ensure your changes follow the project's coding standards and guidelines.

  2. Add Your Changes:Add all the changes you made by using this command below:

git add .
  1. Commit Your Changes: Commit your changes with a clear and concise commit message that describes the purpose of the commit. Use the following command to commit your changes:
git commit -m  "add feature: describe the feature or fix"
  1. Push Your Changes: Push your changes to your forked repository on GitHub:
git push --set-upstream origin (your branch)

  1. Create a Pull Request (PR): Once your changes are committed and pushed, go to the original project repository on GitHub and click the "Compare & pull request" button. Describe your changes and submit the PR. Be sure to reference the issue you're addressing.

  2. Code Review and Collaboration: Project maintainers will review your PR. Be prepared to make changes or address feedback if necessary. Collaborate with the maintainers to ensure your contribution aligns with the project's goals.

  3. Merge Your PR: Once your PR is approved, it will be merged into the main project. Congratulations, you've successfully contributed to Wikidata for Education!We appreciate your contributions and look forward to collaborating with you!

Thank you for helping make educational resources more accessible and valuable through Wikidata.