CONTRIBUTING.md

Contributing to Tentacle PLC

First off, thanks for taking the time to contribute!

Tables of Contents

• What is Tentacle PLC?
• Contributing on GitHub
  • Additional resources
• Setting up local environment for Tentacle PLC
• Setting up local environment for docs
• FAQs
• References

What is Tentacle PLC?

• See the Tentacle PLC Guide Main Page and Introduction Page to learn more about this project

Contributing on GitHub

• How to Contribute to an Open Source Project on GitHub
• GitHub Standard Fork & Pull Request Workflow

Additional resources

• Set up Git - From GitHub
• GitHub flow - From GitHub
• Collaborating with pull requests - From GitHub
• Learn Version control with Git - From Git Tower

Setting up local environment for Tentacle PLC

• TODO
• Similar to Tentacle

Setting up local environment for documentation

• Clone tentacle-plc
• Install Node.js v16.13.2
• Open up the repository
• Change directory to docs folder
• Add the token for Greensock
• Run the npm install
• Then run npm run docs:dev to start and run the local server
• Press CTRL + C to stop the local server

FAQs

• Why create Tentacle PLC?
  • See @joyja response here

References

• Contributing to Atom
• GitHub docs contributing guide