From 83ceb31967b1c8b1a130fa971af46ad743995aa5 Mon Sep 17 00:00:00 2001 From: "W2.Wizard" <63303990+W2Wizard@users.noreply.github.com> Date: Sat, 23 Jan 2021 01:37:46 +0100 Subject: [PATCH 1/2] Added contribution guidelines Since there were no set out guidelines for contributing, I decided to add them. The guidelines overall are very straightforward. --- CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..31ce62f85 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,32 @@ +# How to contribute to the FlaxEngine + +For any questions, suggestions or help join our discord! + + + +Want to see whats planned for Flax? + +Go check out our [Trello](https://trello.com/b/NQjLXRCP/flax-roadmap). + +## **Found a bug?** + +* Avoid opening any new issues without having checked if your problem has already been reported. If there are no currently open issues that fit your problem's description, feel free to [add it](https://github.com/FlaxEngine/FlaxEngine/issues/new). + +* When writing an issue make sure to include a clear title and description as well as having filled out all the necessary information, depending on the severity of the issue also include the necessary log files and minidump. + +* Try to following the given template when writing a new issue if possible. + +## **Want to contribute?** + +* When creating a PR for fixing an issue/bug make sure to describe as to what led to the fix as well as mentioning the + relevant issue where it was first mentioned if necessary, for small and obvious fixes this is not needed. + +* For feature PR's the first thing you should evaluate is the value of your contribution, as in, would what it bring to this engine? + If its a small change you could preferably suggest it to us on our discord, else feel free to open up a PR for it. + +* Ensure when creating a PR that your contribution is well explained with a adequate description and title. + +* For large contributions, generally good code quality is expected, make sure your contribution works as intended and is appropriately commented where necessary. + + +Thank you for taking interest in contributing to Flax! From bf147ba13a2a89bdc7591d37e34dc83c4d033469 Mon Sep 17 00:00:00 2001 From: "W2.Wizard" Date: Sat, 23 Jan 2021 17:15:46 +0100 Subject: [PATCH 2/2] Sentence restructuring --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 31ce62f85..e8eb1eb47 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,15 +18,15 @@ Go check out our [Trello](https://trello.com/b/NQjLXRCP/flax-roadmap). ## **Want to contribute?** -* When creating a PR for fixing an issue/bug make sure to describe as to what led to the fix as well as mentioning the - relevant issue where it was first mentioned if necessary, for small and obvious fixes this is not needed. +* When creating a PR for fixing an issue/bug make sure to describe as to what led to the fix for better understanding, for small and obvious fixes this is not really needed. + However make sure to mention the relevant issue where it was first reported if possible. -* For feature PR's the first thing you should evaluate is the value of your contribution, as in, would what it bring to this engine? +* For feature PR's the first thing you should evaluate is the value of your contribution, as in, what would it bring to this engine? Is it really required? If its a small change you could preferably suggest it to us on our discord, else feel free to open up a PR for it. * Ensure when creating a PR that your contribution is well explained with a adequate description and title. -* For large contributions, generally good code quality is expected, make sure your contribution works as intended and is appropriately commented where necessary. +* Generally, good code quality is expected, make sure your contribution works as intended and is appropriately commented where necessary. Thank you for taking interest in contributing to Flax!