Skip to content

Commit

Permalink
Added contribution instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
fisothemes committed Nov 10, 2024
1 parent a4117a7 commit e6a8460
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# 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](https://fisothemes.github.io/TwinCAT-ADS-Guide-in-.NET/).
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](https://github.com/fisothemes/TwinCAT-ADS-Guide-in-.NET/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](./src/book/contributors.md) 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.

0 comments on commit e6a8460

Please sign in to comment.