Skip to content

Latest commit

 

History

History
40 lines (25 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

40 lines (25 loc) · 2.23 KB

Contributing

Thank you for your interest in contributing to the TwinCAT ADS Guide in .NET! Your feedback, suggestions, and code contributions to improve the documentation are welcome.

Getting Started

If you’re new to contributing, here are some general steps to help you get started:

  1. Read through the guide on the GitHub Pages site.
  2. Check open issues to see if others have already reported your question, idea, or issue.
  3. Submit a new issue if you’ve found a bug or have a suggestion. Describe the change or problem as clearly as possible.
  4. Create a pull request if you’d like to contribute content directly. Additions, corrections, and other helpful content is always welcomed.

Ways to Contribute

Reporting Issues

  • Please use GitHub Issues to report any bugs, typos, or unclear sections.
  • Include as much detail as possible, such as:
    • What part of the guide needs improvement or fixing
    • Any screenshots, code samples, or error messages that clarify the issue

Suggesting Enhancements

If you have ideas for additional topics or sections, submit a GitHub issue and label it as an enhancement. This helps keep the guide relevant and useful to more users.

Submitting Pull Requests

  1. Fork the repository and create a new branch for your changes.
  2. Add clear and concise commits that explain the purpose of each change.
  3. Submit a pull request describing your additions or edits.
  4. Make sure your pull request passes any checks and aligns with the overall style and tone of the guide.

Updating the Contributors Page

If you make a contribution, PLEASE ACKNOWLEDGE IT! Please add your GitHub username to the Contributors page in the book. You can do this by editing contributors.md in the src/book/ directory. Simply add your GitHub username to the list in a new bullet point.

Formatting and Style

Aim for a clear, concise, and accessible writing style. Please use British English and follow the formatting used throughout the guide. When possible, include sample code and references to make your contributions practical.