From 21d58a3733de46252ba25efeb706194e696c7009 Mon Sep 17 00:00:00 2001 From: Alexandra Date: Tue, 12 Dec 2023 18:38:46 +0100 Subject: [PATCH] Update doc repo collaterals (#1584) * Update repo collaterals * Fix links in Contributing.md * Update CONTRIBUTING.md * Update SECURITY.md * Update CONTRIBUTING.md * wording fix --- CONTRIBUTING.md | 40 ++++++++++++++++++++++------------------ SECURITY.md | 29 +++++++++++++++++++++++++++++ SUPPORT.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 93 insertions(+), 18 deletions(-) create mode 100644 SECURITY.md create mode 100644 SUPPORT.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 78a6a595d7..63cfb6825c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,34 +17,38 @@ # How to Contribute -We welcome community contributions to Intel(R) Extension for Scikit-learn. You can: +As an open source project, we welcome community contributions to Intel(R) Extension for Scikit-learn. +This document explains how to participate in project conversations, log bugs and enhancement requests, and submit code patches. -- Submit your changes directly with a [pull request](https://github.com/intel/scikit-learn-intelex/pulls). -- Log a bug or make a feature request with an [issue](https://github.com/intel/scikit-learn-intelex/issues). +## Licensing -Refer to our guidelines on [pull requests](#pull-requests) and [issues](#issues) before you proceed. +Intel(R) Extension for Scikit-learn uses the [Apache 2.0 License](https://github.com/intel/scikit-learn-intelex/blob/master/LICENSE). +By contributing to the project, you agree to the license and copyright terms and release your own contributions under these terms. -## Issues +## Pull Requests -Use [GitHub issues](https://github.com/intel/scikit-learn-intelex/issues) to: -- report an issue -- make a feature request +No anonymous contributions are accepted. The name in the commit message Signed-off-by line and your email must match the change authorship information. -**Note**: To report a vulnerability, refer to [Intel vulnerability reporting policy](https://www.intel.com/content/www/us/en/security-center/default.html). +Make sure your ``.gitconfig`` is set up correctly so you can use `git commit -s` for signing your patches: -## Pull Requests +`git config --global user.name "Kate Developer"` -To contribute your changes directly to the repository, do the following: -- Make sure you can build the product and run all the examples with your patch. -- For a larger feature, provide a relevant example. -- Document your code. -- [Submit](https://github.com/intel/scikit-learn-intelex/pulls) a pull request into the `master` branch. Provide a brief description of the changes you are contributing. +`git config --global user.email kate.developer@company.com` + +### Before Contributing Changes -Public CI is enabled for the repository. Your PR should pass all of our checks. We will review your contribution and, if any additional fixes or modifications are necessary, we may give some feedback to guide you. When accepted, your pull request will be merged into our GitHub repository. +* Make sure you can build the product and run all the tests with your patch. +* For a larger feature, provide a relevant test. +* Document your code. Our project uses reStructuredText for documentation. +* For new file(s), specify the appropriate copyright year in the first line. +* Submit a pull request into the master branch. + +Continuous Integration (CI) testing is enabled for the repository. Your pull request must pass all checks before it can be merged. We will review your contribution and may provide feedback to guide you if any additional fixes or modifications are necessary. When reviewed and accepted, your pull request will be merged into our GitHub repository. ## Code Style -We use [black](https://black.readthedocs.io/en/stable/) and [isort](https://pycqa.github.io/isort/) formatters for Python* code. The line length is 90 characters; use default options otherwise. You can find the linter configuration in our [.pyproject.toml](https://github.com/intel/scikit-learn-intelex/blob/master/pyproject.toml). +We use [black](https://black.readthedocs.io/en/stable/) and [isort](https://pycqa.github.io/isort/) formatters for Python* code. The line length is 90 characters; use default options otherwise. You can find the linter configuration in [.pyproject.toml](https://github.com/intel/scikit-learn-intelex/blob/master/pyproject.toml). + A GitHub* Action verifies if your changes comply with the output of the auto-formatting tools. Optionally, you can install pre-commit hooks that do the formatting for you. For this, run from the top level of the repository: @@ -52,4 +56,4 @@ Optionally, you can install pre-commit hooks that do the formatting for you. For ```bash pip install pre-commit pre-commit install -``` \ No newline at end of file +``` diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000000..71cd791fe3 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,29 @@ + + +# Security Policy + +## Report a Vulnerability + +Please report security issues or vulnerabilities to the [Intel Security Center]. + +For more information on how Intel works to resolve security issues, see +[Vulnerability Handling Guidelines]. + +[Intel Security Center]:https://www.intel.com/security + +[Vulnerability Handling Guidelines]:https://www.intel.com/content/www/us/en/security-center/vulnerability-handling-guidelines.html diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 0000000000..740099713f --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,42 @@ + + +# Intel(R) Extension for Scikit-learn Support + +We are committed to providing support and assistance to help you make the most out of Intel(R) Extension for Scikit-learn. +Use the following methods if you face any challenges. + + +## Issues + +If you have a problem, check out the [GitHub Issues](https://github.com/intel/scikit-learn-intelex/issues) to see if the issue you want to address is already reported. +You may find users that have encountered the same bug or have similar ideas for changes or updates. + +You can use issues to report a problem, make a feature request, or add comments on an existing issue. + +## Discussions + +Visit the [GitHub Discussions](https://github.com/intel/scikit-learn-intelex/discussions) to engage with the community, ask questions, or help others. + +## Forum + +Ask questions about Intel(R) Extension for Scikit-learn on our [Forum](https://community.intel.com/t5/Intel-Distribution-for-Python/bd-p/distribution-python). +Make sure to provide all relevant details, so we could help you as soon as possible. + +## Email + +Reach out to us privately via [email](mailto:onedal.maintainers@intel.com).