Skip to content

Commit

Permalink
Fixed spelling and removed unnecessary line breaks.
Browse files Browse the repository at this point in the history
  • Loading branch information
Roald87 committed May 11, 2021
1 parent 583bffa commit cc28b27
Showing 1 changed file with 16 additions and 39 deletions.
55 changes: 16 additions & 39 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,32 @@
# Contributing to TcBlack
We love your input! We want to make contributing to this project as easy and
transparent as possible, whether it's:
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer

You can also work on an open issue. Issues which are not assigned to anyone, are up for
grabs.
You can also work on an open issue. Issues which are not assigned to anyone, are up for grabs.

## We Develop with Github
We use GitHub to host code, to track issues and feature requests, as well as accept
pull requests.
## We Develop with GitHub
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
Pull requests are the best way to propose changes to the codebase (we use
[Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively
welcome your pull requests:
## We Use [GitHub Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
Pull requests are the best way to propose changes to the codebase (we use [GitHub Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:

1. Fork the repo and create your branch from `master`.
2. Make the changes in your forked branch.
2. If you've added new functionality, it's necessary to add tests. For this there is a
separate test project called [TcBlackTests](https://github.com/Roald87/TcBlack/tree/master/src/TcBlackTests).
In that project there is a seperate test suite defined for each class in TcBlack.
**No new functionality will be accepted without any proper tests**.
3. If you've added new functionality, it's necessary to add tests. For this there is a separate test project called [TcBlackTests](https://github.com/Roald87/TcBlack/tree/master/src/TcBlackTests). In that project there is a separate test suite defined for each class in TcBlack. **No new functionality will be accepted without any proper tests**.
3. Ensure the test suite passes.
4. Issue that pull request!

## Any contributions you make will be under the MIT Software License
In short, when you submit code changes, your submissions are understood to be under the
same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project.
Feel free to contact the maintainers if that's a concern.
same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.

## Report bugs/ideas using Github's [issues](https://github.com/Roald87/TcBlack/issues)
We use GitHub issues to track public bugs and collect ideas. Report a bug or suggest an
idea by [opening a new issue](https://github.com/Roald87/TcBlack/issues/new);
it's that easy!
## Report bugs/ideas using GitHub's [issues](https://github.com/Roald87/TcBlack/issues)
We use GitHub issues to track public bugs and collect ideas. Report a bug or suggest an idea by [opening a new issue](https://github.com/Roald87/TcBlack/issues/new); it's that easy!

## Write bug reports and ideas with detail, background, and sample code

Expand All @@ -55,38 +44,26 @@ that didn't work).
## Build environment
* Make sure to edit the project with the same version of Visual Studio as the master
branch. TcBlack has been developed using Visual Studio 2017. You can download
[VS2017 Community edition](https://visualstudio.microsoft.com/vs/older-downloads/) for
free.
[VS2017 Community edition](https://visualstudio.microsoft.com/vs/older-downloads/) for free.
* Although most of the development will take place in C#, it is good to use the same
TwinCAT version if you're making changes to the TwinCAT projects. TcBlack currently
uses **TwinCAT 4024.7**.

## Use a Consistent Coding Style
* In order to keep the code readable, a maximum line length of 88 characters is used.
This is the same in [Black](https://github.com/psf/black) for Python. You can add
a [Guideline](https://marketplace.visualstudio.com/items?itemName=PaulHarrington.EditorGuidelines)
to the Visual Studio to help you here.
* In order to keep the code readable, a maximum line length of 88 characters is used. This is the same in [Black](https://github.com/psf/black) for Python. You can add a [Guideline](https://marketplace.visualstudio.com/items?itemName=PaulHarrington.EditorGuidelines) to the Visual Studio to help you here.

Furthermore use the following TwinCAT editor settings:

* Make sure that your TwinCAT development environment uses spaces instead of tabs. The
default behaviour of the TwinCAT development environment is to use tabs so it needs to
be changed. The option can be found under **Tools → Options → TwinCAT → PLC Environment
→ Text editor**. Here you want to de-select **Keep tabs**. See also
[this guide](https://alltwincat.com/2017/04/14/replace-tabs-with-whitespaces/).
* Make sure that your TwinCAT development environment uses spaces instead of tabs. The default behavior of the TwinCAT development environment is to use tabs so it needs to be changed. The option can be found under **Tools → Options → TwinCAT → PLC Environment → Text editor**. Here you want to de-select **Keep tabs**. See also [this guide](https://alltwincat.com/2017/04/14/replace-tabs-with-whitespaces/).
* Make sure to set your TwinCAT development environment to use Separate LineIDs. This
is available in the TwinCAT XAE under
**Tools → Options → TwinCAT → Write options → Separate LineIDs** (set this to TRUE,
more information is available [here](https://infosys.beckhoff.com/english.php?content=../content/1033/tc3_userinterface/18014403202147467.html&id=)).
is available in the TwinCAT XAE under **Tools → Options → TwinCAT → Write options → Separate LineIDs** (set this to TRUE, more information is available [here](https://infosys.beckhoff.com/english.php?content=../content/1033/tc3_userinterface/18014403202147467.html&id=)).

## Testing
If you've implemented a new feature, you can try it by formatting or adding a file to
the ShowcaseProject. Please only commit pre-formatted versions of these files,
otherwise others can't use it. To show the new feature you can update the README's
Current state section.
If you've implemented a new feature, you can try it by formatting or adding a file to the ShowcaseProject. Please only commit pre-formatted versions of these files, otherwise others can't use it. To show the new feature you can update the README's Current state section.

## License
By contributing, you agree that your contributions will be licensed under its MIT License.

## References
This document was adapted from TcUnits's excellent [contribution guidelines](https://github.com/tcunit/TcUnit/blob/master/CONTRIBUTING.md).

0 comments on commit cc28b27

Please sign in to comment.