From 5589faf196473402e2ff72273aae57a8b65be2ea Mon Sep 17 00:00:00 2001 From: Jaime van Kessel Date: Fri, 2 Jun 2023 11:56:09 +0200 Subject: [PATCH] Update CONTRIBUTING.md Update outdated information on Contributing --- CONTRIBUTING.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 180b6b1461a..47314b6b031 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ Submitting bug reports ---------------------- -Please submit bug reports for all of Cura and CuraEngine to the [Cura repository](https://github.com/Ultimaker/Cura/issues). There will be a template there to fill in. Depending on the type of issue, we will usually ask for the [Cura log](Logging Issues) or a project file. +Please submit bug reports for all of Cura and CuraEngine to the [Cura repository](https://github.com/Ultimaker/Cura/issues). There will be a template there to fill in. Depending on the type of issue, we will usually ask for the [Cura log](https://github.com/Ultimaker/Cura/wiki/Reporting#cura-log) or a project file. If a bug report would contain private information, such as a proprietary 3D model, you may also e-mail us. Ask for contact information in the issue. @@ -8,14 +8,22 @@ Bugs related to supporting certain types of printers can usually not be solved b Requesting features ------------------- -The issue template in the Cura repository does not apply to feature requests. You can ignore it. - When requesting a feature, please describe clearly what you need and why you think this is valuable to users or what problem it solves. Making pull requests -------------------- -If you want to propose a change to Cura's source code, please create a pull request in the appropriate repository (being [Cura](https://github.com/Ultimaker/Cura), [Uranium](https://github.com/Ultimaker/Uranium), [CuraEngine](https://github.com/Ultimaker/CuraEngine), [fdm_materials](https://github.com/Ultimaker/fdm_materials), [libArcus](https://github.com/Ultimaker/libArcus), [cura-build](https://github.com/Ultimaker/cura-build), [cura-build-environment](https://github.com/Ultimaker/cura-build-environment), [libSavitar](https://github.com/Ultimaker/libSavitar), [libCharon](https://github.com/Ultimaker/libCharon) or [cura-binary-data](https://github.com/Ultimaker/cura-binary-data)) and if your change requires changes on multiple of these repositories, please link them together so that we know to merge them together. +If you want to propose a change to Cura's source code, please create a pull request in the appropriate repository. Since Cura has multiple repositories that influence it, we've listed the most important ones below: +* [Cura](https://github.com/Ultimaker/Cura) +* [Uranium](https://github.com/Ultimaker/Uranium) +* [CuraEngine](https://github.com/Ultimaker/CuraEngine)* +* [fdm_materials](https://github.com/Ultimaker/fdm_materials) +* [libArcus](https://github.com/Ultimaker/libArcus) +* [libSavitar](https://github.com/Ultimaker/libSavitar) +* [libCharon](https://github.com/Ultimaker/libCharon) +* [cura-binary-data](https://github.com/Ultimaker/cura-binary-data)) + +If your change requires changes on multiple of these repositories, please link them together so that we know to merge & review them together. The style guide for code contributions to Cura and other Ultimaker projects can be found [here](https://github.com/Ultimaker/Meta/blob/master/general/generic_code_conventions.md). -Some of these repositories will have automated tests running when you create a pull request, indicated by green check marks or red crosses in the Github web page. If you see a red cross, that means that a test has failed. If the test doesn't fail on the Master branch but does fail on your branch, that indicates that you've probably made a mistake and you need to do that. Click on the cross for more details, or run the test locally by running `cmake . && ctest --verbose`. +Some of these repositories will have automated tests running when you create a pull request, indicated by green check marks or red crosses in the Github web page. If you see a red cross, that means that a test has failed. If the test doesn't fail on the Main branch but does fail on your branch, that indicates that you've probably made a mistake and you need to do that. Click on the cross for more details, or run the test locally by running `cmake . && ctest --verbose`.