From 5588c2075ccdbe75336c8b34dc785a04397150d8 Mon Sep 17 00:00:00 2001 From: Emil Ernerfeldt Date: Sat, 19 Dec 2020 23:14:57 +0100 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..430ce5fdd --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,26 @@ +# Contributing guidelines + +You are welcome to contribute to Egui via discussions, issues, pull requests and by publishing Egui integrations. + +## Discussion + +You can ask questions, share screenshots and more at GitHub Discussions: https://github.com/emilk/egui/discussions + +There is also an Egui channel on the Embark discord at (NOTE: I work at [Embark](https://www.embark-studios.com/), but Egui is my hobby project). + +## Filing an issue + +Issues are for bug reports and feature requests. Issues are not for asking questions (use [Discussions](https://github.com/emilk/egui/discussions) for that). + +Always make sure there is not already a similar issue to the one you are creating. + +If you are filing a bug, please provide a way to reproduce it. + +## Making a PR + +Always file an issue (or find an existing one) and get feedback before you start working on a non-trivial pull request! + +## Creating an integration for Egui + +If you make an integration for Egui for some engine or renderer, please share it with the world! +I will add a link to it from the Egui README.md so others can easily find it.