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!
New Team Members Welcome...
- Canaan Seaton - Owner - GitHub Profile - Personal Website
- Patrick McDonagh - Collaborator - GitHub Profile
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 ;)
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
- To Learn about CIP and Ethernet/IP - See the Manuals folder
- Ask - See the project Gitter community
- Blog Posts - Coming Soon....
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.
- Research to make sure the issue isn't already being tracked
- Submit your issue via the project issue tracker
- 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 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?
- Submit your feature request to the issue tracker **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 as a starting point
Contributing Code
- Open an issue if one doesn't already partain to your contribution
- 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
- Assumming the outcome of the above discussion good to go, fork the Repo
- Clone your forked copy to your local machine
- Add the host repo as upstream ->
git remote add upstream https://github.com/cmseaton42/node-ethernet-ip.git - Get acclamated with the environment (ask questions if necessary)
- Make a new branch for your changes
- Start hacking away at some crispy new code
- Make sure to add tests
- Submit you're PR to the Primary repo
- Protip: Use the Pull Request Template as a starting point
- Wait for feedback
- Make changes if necessary and re-submit
- Boom, PR accepted 👍 💯 🎉