Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PTKu authored Dec 11, 2023
1 parent f6ef51a commit d6256c7
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# Thanks!

Thank you for considering contributing to this project. This document will help you to get started and guide you through the process. Industrial automation has developed very limited culture of open-souce development. The most important is to get started and enjoy the wave of endorfins once your pull request is approved. It does not have to be anything big, maybe just typo in the documentation, question or idea to discuss.
Thank you for considering contributing to this project. This document will help you to get started and guide you through the process. Industrial automation has developed a minimal culture of open-source development. The most important is to get started and enjoy the wave of endorphins once your pull request is approved. It does not have to be anything significant, a typo in the documentation, question, or idea to discuss.

# Contributing

When contributing to this repository, please first discuss the change you wish to make via [issue](https://github.com/ix-ax/axsharp/issues) or open a [discussion](https://github.com/ix-ax/axsharp/discussions).

**IMPORTANT!!!** If you discover a **security issue do not disclose that information** in public spaces of the repo (issues, discussions), more info [here](SECURITY.md).
**IMPORTANT!!!** If you discover a **security issue, do not disclose that information** in public spaces of the repo (issues, discussions), more info [here](SECURITY.md).

## Before you contribute

- Your contributions are under MIT license.
- Make sure you work with tools and versions listed in the [pre-requisites](docs/articles/general/REQUISITES.md).
- Use consistent coding style, find more info in [coding style document](docs/articles/general/CODING_STYLE.md) of this project.
- Make sure you work with tools and versions listed in the [pre-requisites](docfx/index.md#prerequisites).
- Use consistent coding style, find more info in [coding style document](docfx/articles/general/CODING_STYLE.md) of this project.
- All changes happen via pull requests.
- Additions or changes to the code should contain [in-code documentation](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/language-specification/documentation-comments) .
- Additions or changes should be reflected in how-to and readme documentation.
Expand All @@ -21,5 +21,5 @@ When contributing to this repository, please first discuss the change you wish t
## Pull Request Process

1. Ensure any install or build dependencies are removed before requesting approval.
1. Describe the change in the PR use this [template](.github/PULL_REQUEST_TEMPLATE/pull_request_template.md) if applicable.
1. Describe the change in the PR use this [template](.github/pull_request_template.md#description) if applicable.
1. Pull requests will be reviewed and merged by repository maintainers.

0 comments on commit d6256c7

Please sign in to comment.