Skip to content

Latest commit

 

History

History
91 lines (69 loc) · 4.94 KB

CONTRIBUTING.md

File metadata and controls

91 lines (69 loc) · 4.94 KB

Contributing to Learn WebAnim Developer Portal Repository

🎉Welcome! We're excited that you're interested in contributing to the Learn WebAnim Developer Portal. Whether you're a beginner or an experienced developer, your contributions can help create a resourceful, educational environment for everyone in our community.

To make the contribution process smooth and ensure high-quality submissions, please follow these guidelines.

🌟 How to Contribute

1. Fork the Repository

Start by forking this repository. Click on the Fork button at the top-right corner of this page, then clone your fork to your local machine:

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

2. Create an Issue (Optional)

If you plan to work on something new, we recommend opening an issue first, describing what you'd like to contribute (e.g., a new project, tutorial, or approach to a coding challenge). This will help prevent duplicate contributions and ensure your idea aligns with the project goals.

Once the issue is approved or labeled as "good to go", you can begin working on it!

3. Make Changes in a New Branch

To make conflicts and keep the main branch clean, create a new branch for your work:

git checkout -b your-branch-name

4. Follow the Contribution Template

Please ensure that your contribution follows the template for the specific section you're working on. These templates will help keep the repository well-organized and make contributions easy to understand.

For Projects Projects should include:

  • README.md: Explaining the project goals, how to run the project, and the expected output.
  • Code: A complete, functional codebase with clear comments.

For Tutorials

Tutorials should include:

  • Explanation: A step-by-step breakdown of the topic, with practical examples.
  • Code snippets: If relevant, include simple code snippets that illustrate the concept.
  • Optional exercises: Encourage users to practice what they've learned.

For Challenges

Coding challenges should focus on explaining approaches, rather than providing full solutions.

  • Problem breakdown: Describe how to approach the problem.
  • Hints: Include any tips or hints to help others solve the challenge.
  • Pseudocode/Diagrams: Visual aidsor pseudocode to illustrate your thinking.

For Interview Questions

Contributions should include:

  • Question breakdown: How to approach and solve the question.
  • Key concepts: Explain any necessary theory.
  • Common pitfalls: Mention things to watch out for during interviews.

5. Test Your Changes

If your contribution involves code, ensure that everything runs correctly. Please test your code thoroughly before submitting it.

6. Commit and Push Your Work

Once you're satisfied with your contribution, commit your changes with a descriptive message:

git add .
git commit -m "Add tutorial on recursion basics"
git push origin your-branch-name

7. Submit a Pull Request (PR)

Once your changes are pushed to your fork, open a pull request on this repository:

  1. Go to the Pull Requests tab of the original repo.
  2. Click New Pull Request.
  3. Select te branch you just pushed from your fork.
  4. Add a meaningful title and description explaining your contribution.
  5. Submit your PR.

Your PR will be reviewed, and any necessary feedback will be provided. Don't worry if it's not perfect the first time - we're here to help you improve!

👀 Code of Conduct

By participating, you agree to abide by our Code of Conduct, ensuring that the community remains a welcoming, inclusive, and respectful space.

🏅 Contribution Best Practices

To ensure your contribution is valuable to the community:

  1. Stay on Topic: Ensure your contribution aligns with the purpose of this repository. We aim to help developers learn through practical guidance, so focus on clarity and teaching.
  2. Write Clearly: Contributions shoud be easy to understand, with well-commented code and clear explanations.
  3. Collaborate: You can always collaborate with other contributors by asking questions, giving feedback, or pairing up to work on an issue.
  4. Respect Reviews: Be open to feedback! Code reviews are meant to improve both your code and your skills.

🤝🏼 First-Time Contributors

New to open source? No problem! Check out our How to Contribute guide for a step-by-step introduction on how to make your first contribution. We also recommend checking out GitHub's Hello World Guide to get familiar with Git and GitHub.

🔖 Licensing

By contributing to this repository, you agree that your contributions will be licensed under the MIT License

Thank you for helping build a valuable resource for developers! Your contributions, no matter how big or small, are what make this community thrive. Happy Coding! ✨