Skip to content

Contributing

Joseph Bozarth edited this page Aug 23, 2019 · 3 revisions

Contributing to i3Plus+

This is a community supported open-source project that relies entirely on volunteers who donate their time and effort to keep it going and up to date. If there is some issue you would like to see fixed and you know how to fix it please take the initiative and open a pull request for the fix so we can review, discuss, and get the fix merged and released.

There are just a few things to know and consider when making updates to this project that I have outlined here.

Is this change specific to this printer or does it apply to Marlin in general?

If the change or issue you are seeing is with Marlin in general and not specific to this printer or the modifications we have made to the firmware for it the best place to fix that issue is going to be in the main Marlin repo so that we can get that fix out to all Marlin users. Once it is merged there we can pull the change into here and get this project updated.

If the change is specific to this printer or the specific changes for this project then this is the correct place to be fixing it so opening a pull request or issue here for the changes is the best course of action.

Ways to contribute

  • Submit some code. If you know C/C++ and want to make the change yourself please fork the repo, make the changes, and open a PR
  • Submit issues when you find them. If you come across some issue, let us know about it. File an issue with detailed steps to reproduce and we will look into it.
  • Promote the project. All open source projects need a community to help them live and thrive. If this project helped you out let others know and share the project around.

Community Guidelines (basically the same as Marlin)

i3Plus+ is hosted on GitHub, so you’ll need a free GitHub user account to post issues and take part in development. GitHub provides tools to ban fake and SPAM users, but it’s up to each project to maintain general civility by adhering to some basic policies.

  • Read and use the “New Issue” template for best results with bug reports and feature requests.
  • Limit issues to a single topic. You can always spawn new issues if more topics arise.
  • Keep discussions concise and limited to technical issues. Steer back to the main topic if sidetracked.
  • Be respectful to other contributors, especially in disagreements. We want everyone to enjoy the experience.
  • We have Zero Tolerance policy for personal attacks, racism, discrimination, or bigotry of any kind. There is no place for that kind of behavior here and users will be banned for violating this policy.
  • Pay attention to your issues and follow up on them. Stale issues may be closed without notice.
  • If your issue is resolved, please post a message and close it.