djkato/egui
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Create CONTRIBUTING.md

Browse source
This commit is contained in:
Emil Ernerfeldt 2020-12-19 23:14:57 +01:00 committed by GitHub
parent 58c025a7e3
commit 5588c2075c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
CONTRIBUTING.md Normal file
View file

@ -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 <https://discord.gg/vY8ZGS292W> (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.