Skip to content

Latest commit

 

History

History
55 lines (33 loc) · 3.32 KB

CONTRIBUTING.md

File metadata and controls

55 lines (33 loc) · 3.32 KB
Raw

Contributor Manual for Schematics Documentation

Welcome to our project! We're thrilled to have you here and appreciate contributions of any size and skill level. This project uniquely bridges Schematics with the wider JavaScript ecosystem, and we're excited to see the innovative ways you'll help us expand its capabilities.

How to Get Started

First, familiarize yourself with our project's existing documentation at Schematics Documentation. Understanding what's already covered will help you identify areas for improvement or new topics that could benefit our users.

Types of Documentation Contributions

We value a wide range of contributions, from code to documentation, from new schematics to improving existing ones for better compatibility with non-Angular environments. Here are some ways you can contribute:

  • Tutorial Contributions: Have you developed a unique solution or implemented an interesting use case with Schematics? We'd love to see your walkthroughs, step-by-step guides, or comprehensive tutorials.

  • Error Corrections: If you notice inaccuracies, typos, or outdated information in our documentation, please let us know. Your keen eye can help ensure our documentation remains accurate and useful.

  • Adding New Information: Technology evolves rapidly, and so do best practices. Contributions that add new insights, tips, or best practices are always welcome.

Submitting Your Contribution

Reporting Issues

If you encounter an issue with existing documentation (be it a typo, error, or omission), please create an issue on our GitHub repository. Include the following in your report:

  • A descriptive title
  • A clear description of the issue
  • Suggestions for correction or improvement
  • Any relevant links or examples

Making Pull Requests

Ready to add your tutorial, fix, or update directly? Here's how to submit a pull request (PR):

  1. Fork the repository and create your branch from main.
  2. Make your changes: Add your tutorial, correction, or new information. Ensure your contribution is well-written and follows our documentation style guide.
  3. Submit a pull request: Provide a clear PR title and description that outlines the changes you've made and why they're beneficial.

Writing a Good Tutorial or Documentation Update

  • Be Clear and Concise: Assume the reader is learning about the topic for the first time.
  • Use Examples: Practical examples help clarify abstract concepts.
  • Include Screenshots or Diagrams: Visual aids can make tutorials easier to understand.
  • End with a Summary: Recap the key takeaways to reinforce learning.

Review Process

Every contribution is valuable, and we take the time to review each one. Here's what happens after you submit a PR:

  • Initial Review: Our team will review your submission for clarity, accuracy, and relevance.
  • Feedback: If necessary, we'll provide feedback or request changes. This is a collaborative process, and we may go back and forth a few times.
  • Approval and Merge: Once your contribution meets our standards, it will be approved and merged into our documentation.

Community Support

Thank you for contributing to the Schematics documentation. Your efforts help make our community a richer and more knowledgeable space.