Skip to content

Latest commit

 

History

History
95 lines (81 loc) · 5.01 KB

How_to_Contribute.md

File metadata and controls

95 lines (81 loc) · 5.01 KB

How to Contribute to the Learn WebAnim Developer Learning Portal

We're excited that you want to contribute to Learn WebAnim's Developer Learning Portal Repostiory! Whether you're an experienced developer or new to open source, your contributions are valuable. This guide will walk you through how to make meaningful contributions.

📋 Table of Contents

🚦 Before Your Start

  1. Read the Project Overview: Familiarize yourself with the repository's purpose by reviewing the README.md.
  2. Understand the Code of Conduct: All contributors are expected to adhere to the Code of Conduct.
  3. Find or Create an Issue: Check the issues to see if there's already something you can work on, or open a new issue to propose your contribution.

💡 Ways to Contribute

Here's how you can help the community:

  • Add New Projects: Share beginner, intermediate, or advanced project ideas with step-by-step instructions.
  • Write Tutorials: Create tutorials on coding languages, concepts, or best practices.
  • Solve Challenges: Contribute your approach to coding challenges by explaining the problem-solving process.
  • Prepare Interview Question Guides: Break down common interview questions and guide developers on how to approach and solve them.
  • Improve Documentation: Help make the repository more beginner-friendly by improving the documentation, fixing typos, or adding clarity.

🛠 Step-by-Step Contributeion Process

1. Fork the Repository

Start by forking the repository to your GitHub account. Click the Fork button at the top-right corner of this repository.

2. CLone Your Fork

Once you've forked the repository, clone your fork to your local machine:

git clone https://github.com/your-username/Developer-Portal.git

Navigate into the repository folder:

cd Developer-Portal

3. Create a New Branch

To keep your changes isolated and avoid conflicts, create a new branch for your contribution:

git checkout -b your-branch-name

Use a descriptive name for your branch, such as add-tutorial-recursion or fix-typo-in-readme.

4. Make Your Changes

Now that you're on a new branch, make the necessary changes or additions:

  • Write code, add explanations, create diagrams, etc.
  • Follow the appropriate templates for adding projects, tutorials, or challenges (found in the /Templates folder).

5. Test Your Work

If your contribution involves code, ensure it runs as expected. Thoroughly test any code additions or modifications before submitting.

6. Commit and Push

Once you're happy with your changes, commit them with a clear, descriptive message:

git add .
git commit -m "Add beginner project on basic recursion"

Then, push your branch to your fork:

git push origin your-branch-name

7. Submit a Pull Request

Now, go to the original repository and submit your pull request:

  1. Navigate to the Pull Requsts tab.
  2. Click on New Pull Request.
  3. Select your forked repository and the branch you've wokred on.
  4. Write a meaningful title and description, explaining what you've contributed.
  5. Submit the pull request (PR).

Once submitted, the repository maintainers will review your PR. If any changes or improvements are requested, please make those revisions before resubmitting.

✍🏼 Contribution Guidelines

To maintain a high standard and ensure everyone benefits from this repository, please keep these guidelines in mind:

  1. Be Clear and Detailed: Make sure your contributions are well-documented and easy to follow, especially if you're adding tutorials or projects.
  2. Keep it Educational: This repository is intended for learning, so focus on explaining how to approach and solve problems rather than simply providing solutions.
  3. Follow Templates: Please use the templates available for each section (e.g., projects, tutorials, coding challenges) to maintain consistency across contributions.
  4. Respect the Code of Conduct: Be respectful and constructive when providing feedback or interacting with others.
  5. ** No Plagiarism**: Ensure all your contributions are original, and give credit where necessary.

🙋🏼‍♀️ Need Help?

If you're stuck, have any questions, or need further assistance:

  • Open a new issue on the issues page.
  • Tag the maintainers for support, and they'll help you resolve your query.
  • Review our FAQ for common questions.

We're here to help you become a confident contributor!