53 lines (39 loc) · 3.55 KB

Contributing

Check out our Contributer chart below to see where you can contribute.

What do you like to do	Options for Contributions	Link to Work-flow
Do you like organizing?	Link to duplicate issues and suggest new issue labels to keep things organized	How To
Do you like to test out new features?	Test Sensors and actuators	How To
Do you like to create/make projects?	Make cool projects using the library	How To
Do you like to code?	Add more Sensors/Actuators to the library	How To
	Find an open issue to tackle	How To
Do you like helping others code?	Review code on other people’s submissions	How To
Do you like planning events?	Organize workshops or meetups about the project	How To
Do you like to design?	Restructure layouts (Website, Docs etc..) to improve the project’s usability	How To
	Conduct user research to reorganize and refine the project’s navigation or Documentation	How To
Do you like to write?	Write and improve the project’s documentation	How To
	Curate a folder of examples showing how the project is used	How To
Do you like helping people?	Answer questions about the project on e.g. Stack Overflow	How To

WorkFlow

Flow -->	Identify	Strategize	Execute1	Execute2	Execute3	Execute4	Execute5	Execute6
Contributers can -->	Request	Assign Priority (maintainer only)	Write Code	Review Code	Test	Bugs	Document	Blog/Tutorial
Add a new Feature
Add support to Sensor/Actuator

Above table shows the development Entities, their stages and where you can contribute.

Each Entity (Feature or Sensors/Actuator) has 8 stages which goes from Request to Tutorial.
Each Entity gets a new Issue.
Each Issue gets tagged with the ongoing stage Tag.
You can come in at any stage and help contribute to the project.

Pull Request Process

TBD, contact yogesh@iotiot.in if you want to know more details.

Git Workflow

master branch is always stable and will contain all the releases for the project.
develop branch contains latest commits that will merge to master at release time.
feature-* branches will contain commits for a new feature and will merge to develop.
release-* branches will contain commits for a new released will merge to master.
fix-* branches will contain commits for bug fixes to be merged to develop.

Credits

To opensource.guide for the contributing table - Checkout link
To @nvie for the git branching model that the project uses - Checkout link