Skip to content

Latest commit

 

History

History
63 lines (38 loc) · 2.88 KB

CONTRIBUTING.md

File metadata and controls

63 lines (38 loc) · 2.88 KB

Contributing Guidelines

Thank you for considering contributing to the Modular Multi-Extrusion 3D Printer project! Your contributions are essential in pushing the boundaries of 3D printing technology. Please take a moment to review these guidelines before getting started.

Table of Contents

Code of Conduct

Please review and abide by our Code of Conduct. We strive to create a welcoming and inclusive environment for all contributors.

Getting Started

  • Familiarize yourself with the project by reading the README to understand its goals, features, and roadmap.
  • Join our Community Forum to engage with other contributors and enthusiasts.
  • Explore the Issues section to find tasks, bugs, and feature requests.

How to Contribute

  1. Fork the Repository: Click the "Fork" button on the top-right corner of this repository to create your copy.

  2. Create a Branch: For each feature or bug fix, create a separate branch from develop with a descriptive name (e.g., feature/modular-extruder).

  3. Commit Changes: Make your changes, commit them to your branch, and write meaningful commit messages.

  4. Test: If applicable, ensure your changes are properly tested. We value code quality and stability.

  5. Submit a Pull Request: When ready, submit a pull request (PR) to the develop branch of this repository.

  6. Code Review: Your PR will undergo review by maintainers. Address feedback and iterate as needed.

  7. Merge and Celebrate: Once approved, your changes will be merged into the develop branch. Congratulations!

Issue Etiquette

  • Search existing issues before opening a new one to prevent duplication.
  • Provide a clear description, reproduction steps, and relevant information in your issue.

Pull Request Etiquette

  • Keep PRs focused; consider separate PRs for unrelated changes.
  • Use a clear title and describe your changes in the PR description.
  • Keep your branch up-to-date with develop to avoid conflicts.

Code Guidelines

  • Follow our coding standards and formatting conventions in Coding Standards.
  • Document your code and write concise comments.
  • Provide tests for new features or bug fixes.

Licensing

By contributing, you agree that your work will be licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.

Thank you for being a part of the Modular Multi-Extrusion 3D Printer project. Your contributions are vital in shaping the future of 3D printing technology. Happy coding!