From e09905b7f265e52284709c111447acd60f7fa6e9 Mon Sep 17 00:00:00 2001 From: Wojciech Figat Date: Wed, 8 Dec 2021 09:44:36 +0100 Subject: [PATCH] Update project infos and add security vulnerabilities reporting info #677 --- CODE_OF_CONDUCT.md | 6 ++++++ README.md | 12 ++---------- SECURITY.md | 8 ++++++++ 3 files changed, 16 insertions(+), 10 deletions(-) create mode 100644 SECURITY.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 03fff1aa1..ba3d5a458 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -38,6 +38,12 @@ Instances of abusive, harassing, or otherwise unacceptable behavior may be repor Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. +## Contribution + +Using Flax source code is strictly governed by the Flax Engine End User License Agreement. If you don't agree to those terms, as amended from time to time, you are not permitted to access or use Flax Engine. + +We welcome any contributions to Flax Engine development through pull requests on GitHub. Most of our active development is in the master branch, so we prefer to take pull requests there (particularly for new features). We try to make sure that all new code adheres to the Flax coding standards. All contributions are governed by the terms of the [EULA](https://flaxengine.com/licensing/). + ## Attribution This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] diff --git a/README.md b/README.md index d7afc29d3..e7c7cf565 100644 --- a/README.md +++ b/README.md @@ -42,15 +42,7 @@ Flax Visual Studio extension provides better programming workflow, C# scripts de * Compile Flax project (hit F7 or CTRL+Shift+B) * Run Flax (hit F5 key) ---- - -**Note** - -If building on Windows to support Vulkan rendering, first install the Vulkan SDK then set an environment variable to provide the path to the SDK prior to running GenerateProjectFiles.bat: - -    set VULKAN_SDK=C:\VulkanSDK\version\ - ---- +> When building on Windows to support Vulkan rendering, first install the Vulkan SDK then set an environment variable to provide the path to the SDK prior to running GenerateProjectFiles.bat: `set VULKAN_SDK=C:\VulkanSDK\version\` ## Linux @@ -97,4 +89,4 @@ If building on Windows to support Vulkan rendering, first install the Vulkan SDK Using Flax source code is strictly governed by the Flax Engine End User License Agreement. If you don't agree to those terms, as amended from time to time, you are not permitted to access or use Flax Engine. -We welcome any contributions to Flax Engine development through pull requests on GitHub. Most of our active development is in the master branch, so we prefer to take pull requests there (particularly for new features). We try to make sure that all new code adheres to the Flax coding standards. All contributions are governed by the terms of the EULA. +We welcome any contributions to Flax Engine development through pull requests on GitHub. Most of our active development is in the master branch, so we prefer to take pull requests there (particularly for new features). We try to make sure that all new code adheres to the Flax coding standards. All contributions are governed by the terms of the [EULA](https://flaxengine.com/licensing/). diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 000000000..b86c4a641 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,8 @@ +# Security + +## Reporting security vulnerabilities + +If you've found a security vulnerability in Flax, please do not create an issue on +the GitHub issue tracker as it will be visible publicly. + +Instead, send an email to .