ethernet-ip/CONTRIBUTING.md

A simple node interface for Ethernet/IP.

# Contribute

This is the **CONTRIBUTE** section of our project. Great to have you here. Here are a few ways you can help make this project better!

## Team Members

*New Team Members Welcome...*

* **Canaan Seaton** - *Owner* - [GitHub Profile](https://github.com/cmseaton42) - [Personal Website](http://www.canaanseaton.com/)
* **Patrick McDonagh** - *Collaborator* - [GitHub Profile](https://github.com/patrickjmcd)

## Support

How can I help?

- Simply use the module. The more people who use it, the better it will become.
- Get Involved (see below for more details)
- A freshly dropped star on the repo is always appreciated ;)

## Learn & Listen

This section includes ways to get started with your open source project. Include links to documentation and to different communication channels: 

* How to Open Source - See this excellent [article](https://opensource.guide/how-to-contribute/)
* To Learn about CIP and Ethernet/IP - See the [Manuals](https://github.com/cmseaton42/node-ethernet-ip/tree/master/manuals) folder
* Ask - See the project [Gitter](https://gitter.im/node-ethernet-ip/Lobby) community
* Blog Posts - Coming Soon....          

## Get Involved

So you say you wanna help? Here's how! 🎉 👍

**Submitting Issues** 

Contributing to the Code is great but feedback on the project is just as important.

1. Research to make sure the issue isn't already being tracked
2. Submit your issue via the project [issue tracker](https://github.com/cmseaton42/node-ethernet-ip/issues)
    - Be Clear
    - Be Thorough (too much information >>> not enough information)
    - Include Pictures (Screenshots of Errors, gifs, etc)
    - Include *Node Version* -> `node --version`
    - Include *package version* -> `npm list`

**Protip:** Use the project [Issue Template](https://github.com/cmseaton42/node-ethernet-ip/blob/master/ISSUE_TEMPLATE.md) as a starting point

**Feature Requests** 

Have you ever been working with a project and thought *Man, I wish it just did this out of the box*? 

1. Submit your feature request to the [issue tracker](https://github.com/cmseaton42/node-ethernet-ip/issues) **Be Sure to Mark your Issue as a Feature Request in the title (eg `[FEATURE REQUEST] Some Awesome Idea`)
    - Be Clear
    - Be Thorough (too much information >>> not enough information)
    - Don't submit it and *forget* it, be prepared to answer some follow up questions

**Protip:** Use the project [Issue Template](https://github.com/cmseaton42/node-ethernet-ip/blob/master/ISSUE_TEMPLATE.md) as a starting point

**Contributing Code**

1. Open an issue if one doesn't already partain to your contribution
2. Discuss the changes you want to make in the issue tracker to see if someone is already working on it or if there is a reason it shouldn't be added
1. Assumming the outcome of the above discussion good to go, fork the Repo 
2. Clone your forked copy to your local machine
3. Add the host repo as upstream -> `git remote add upstream https://github.com/cmseaton42/node-ethernet-ip.git`
3. Get acclamated with the environment (ask questions if necessary)
5. Make a new branch for your changes
6. Start *hacking* away at some crispy new code
7. Make sure to add tests 
8. Submit you're PR to the [Primary](https://github.com/cmseaton42/node-ethernet-ip) repo
    - **Protip:** Use the [Pull Request Template](https://github.com/cmseaton42/node-ethernet-ip/blob/master/PULL_REQUEST_TEMPLATE.md) as a starting point
9. Wait for feedback
10. Make changes if necessary and re-submit
11. Boom, PR accepted 👍 💯 🎉