Skip to content

Commit

Permalink
Added CONTRIBUTING.md and SECURITY.md files in Connector/Python
Browse files Browse the repository at this point in the history
Change-Id: If8352546a735208240540e6daa2ccf4f6e433716
  • Loading branch information
SubCoder1 authored and oscpache committed Sep 13, 2024
1 parent 6f81ac5 commit 8a90d72
Show file tree
Hide file tree
Showing 16 changed files with 419 additions and 358 deletions.
358 changes: 358 additions & 0 deletions CONTRIBUTING.md

Large diffs are not rendered by default.

343 changes: 0 additions & 343 deletions CONTRIBUTING.rst

This file was deleted.

2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ Contributing
------------

There are a few ways to contribute to the Connector/Python code. Please refer
to the `contributing guidelines <CONTRIBUTING.rst>`_ for additional information.
to the `contributing guidelines <CONTRIBUTING.md>`_ for additional information.


License
Expand Down
30 changes: 30 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Reporting security vulnerabilities

Oracle values the independent security research community and believes that
responsible disclosure of security vulnerabilities helps us ensure the security
and privacy of all our users.

Please do NOT raise a GitHub Issue to report a security vulnerability. If you
believe you have found a security vulnerability, please submit a report to
[email protected] preferably with a proof of concept. Please review
some additional information on how to report security vulnerabilities to Oracle
(see https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html)
We encourage people who contact Oracle Security to use email encryption using
our encryption key (see https://www.oracle.com/security-alerts/encryptionkey.html)

We ask that you do not use other channels or contact the project maintainers
directly.

# Security updates, alerts and bulletins

Security updates will be released on a regular cadence. Many of our projects
will typically release security fixes in conjunction with the Oracle Critical Patch
Update program. Additional information, including past advisories, is available on our
security alerts page at https://www.oracle.com/security-alerts/

# Security-related information

We will provide security related information such as a threat model, considerations
for secure use, or any known security issues in our documentation. Please note
that labs and sample code are intended to demonstrate a concept and may not be
sufficiently hardened for production use.
3 changes: 2 additions & 1 deletion mysql-connector-python/MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
include README.txt
include README.rst
include LICENSE.txt
include CONTRIBUTING.rst
include CONTRIBUTING.md
include SECURITY.md
include CHANGES.txt
include setup.py
include unittests.py
Expand Down
3 changes: 2 additions & 1 deletion mysql-connector-python/cpydist/bdist.py
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,8 @@ def run(self):
("README.txt", "README.txt"),
("LICENSE.txt", "LICENSE.txt"),
("README.rst", "README.rst"),
("CONTRIBUTING.rst", "CONTRIBUTING.rst"),
("CONTRIBUTING.md", "CONTRIBUTING.md"),
("SECURITY.md", "SECURITY.md"),
("docs/INFO_SRC", "INFO_SRC"),
("docs/INFO_BIN", "INFO_BIN"),
]
Expand Down
8 changes: 6 additions & 2 deletions mysql-connector-python/cpydist/bdist_solaris.py
Original file line number Diff line number Diff line change
Expand Up @@ -208,8 +208,12 @@ def _prepare_pkg_base(self, template_name, data_dir, root=""):
os.path.join(data_path, "README.rst"),
),
(
os.path.join(cwd, "CONTRIBUTING.rst"),
os.path.join(data_path, "CONTRIBUTING.rst"),
os.path.join(cwd, "CONTRIBUTING.md"),
os.path.join(data_path, "CONTRIBUTING.md"),
),
(
os.path.join(cwd, "SECURITY.md"),
os.path.join(data_path, "SECURITY.md"),
),
]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ cd mysql-connector-python
%{?scl:EOF}
%files -n mysql-connector-python3%{?product_suffix}
%doc LICENSE.txt CHANGES.txt README.txt README.rst CONTRIBUTING.rst mysql-connector-python/docs/INFO_SRC mysql-connector-python/docs/INFO_BIN
%doc LICENSE.txt CHANGES.txt README.txt README.rst CONTRIBUTING.md SECURITY.md mysql-connector-python/docs/INFO_SRC mysql-connector-python/docs/INFO_BIN
%{python3_sitearch}/mysql
%{python3_sitearch}/mysql_connector_python-*.egg-info
%{python3_sitearch}/_mysql_connector.cpython*.so
Expand Down
3 changes: 2 additions & 1 deletion mysql-connector-python/cpydist/sdist.py
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,8 @@ def run(self):
("README.txt", "README.txt"),
("LICENSE.txt", "LICENSE.txt"),
("README.rst", "README.rst"),
("CONTRIBUTING.rst", "CONTRIBUTING.rst"),
("CONTRIBUTING.md", "CONTRIBUTING.md"),
("SECURITY.md", "SECURITY.md"),
("docs/INFO_SRC", "INFO_SRC"),
("docs/INFO_BIN", "INFO_BIN"),
]
Expand Down
3 changes: 2 additions & 1 deletion mysql-connector-python/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@
"README.rst",
"LICENSE.txt",
"CHANGES.txt",
"CONTRIBUTING.rst",
"CONTRIBUTING.md",
"SECURITY.md",
)

VERSION_TEXT = "999.0.0"
Expand Down
3 changes: 2 additions & 1 deletion mysqlx-connector-python/MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
include README.txt
include README.rst
include LICENSE.txt
include CONTRIBUTING.rst
include CONTRIBUTING.md
include SECURITY.md
include CHANGES.txt
include setup.py
include unittests.py
Expand Down
3 changes: 2 additions & 1 deletion mysqlx-connector-python/cpydist/bdist.py
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,8 @@ def run(self):
("README.txt", "README.txt"),
("LICENSE.txt", "LICENSE.txt"),
("README.rst", "README.rst"),
("CONTRIBUTING.rst", "CONTRIBUTING.rst"),
("CONTRIBUTING.md", "CONTRIBUTING.md"),
("SECURITY.md", "SECURITY.md"),
("docs/INFO_SRC", "INFO_SRC"),
("docs/INFO_BIN", "INFO_BIN"),
]
Expand Down
8 changes: 6 additions & 2 deletions mysqlx-connector-python/cpydist/bdist_solaris.py
Original file line number Diff line number Diff line change
Expand Up @@ -208,8 +208,12 @@ def _prepare_pkg_base(self, template_name, data_dir, root=""):
os.path.join(data_path, "README.rst"),
),
(
os.path.join(cwd, "CONTRIBUTING.rst"),
os.path.join(data_path, "CONTRIBUTING.rst"),
os.path.join(cwd, "CONTRIBUTING.md"),
os.path.join(data_path, "CONTRIBUTING.md"),
),
(
os.path.join(cwd, "SECURITY.md"),
os.path.join(data_path, "SECURITY.md"),
),
]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ cd mysqlx-connector-python
sed -i -e '/protobuf/d' %{buildroot}%{python3_sitearch}/mysqlx_connector_python-*.egg-info/requires.txt
%files -n mysqlx-connector-python3%{?product_suffix}
%doc LICENSE.txt CHANGES.txt README.txt README.rst CONTRIBUTING.rst mysqlx-connector-python/docs/INFO_SRC mysqlx-connector-python/docs/INFO_BIN
%doc LICENSE.txt CHANGES.txt README.txt README.rst CONTRIBUTING.md SECURITY.md mysqlx-connector-python/docs/INFO_SRC mysqlx-connector-python/docs/INFO_BIN
%{python3_sitearch}/mysqlx
%{python3_sitearch}/mysqlx_connector_python-*.egg-info
%{python3_sitearch}/_mysqlxpb.cpython*.so
Expand Down
3 changes: 2 additions & 1 deletion mysqlx-connector-python/cpydist/sdist.py
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,8 @@ def run(self):
("README.txt", "README.txt"),
("LICENSE.txt", "LICENSE.txt"),
("README.rst", "README.rst"),
("CONTRIBUTING.rst", "CONTRIBUTING.rst"),
("CONTRIBUTING.md", "CONTRIBUTING.md"),
("SECURITY.md", "SECURITY.md"),
("docs/INFO_SRC", "INFO_SRC"),
("docs/INFO_BIN", "INFO_BIN"),
]
Expand Down
3 changes: 2 additions & 1 deletion mysqlx-connector-python/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@
"README.rst",
"LICENSE.txt",
"CHANGES.txt",
"CONTRIBUTING.rst",
"CONTRIBUTING.md",
"SECURITY.md",
)


Expand Down

0 comments on commit 8a90d72

Please sign in to comment.