diff --git a/.gitmodules b/.gitmodules index 3f12985..49bea27 100644 --- a/.gitmodules +++ b/.gitmodules @@ -39,3 +39,6 @@ url = https://github.com/google/globalfoundries-pdk-ip-gf180mcu_fd_ip_sram.git branch = main shallow = true +[submodule "third_party/open-source-pdks"] + path = third_party/open-source-pdks + url = https://github.com/google/open-source-pdks.git diff --git a/CODE_OF_CONDUCT.rst b/CODE_OF_CONDUCT.rst new file mode 100644 index 0000000..ef1ddcd --- /dev/null +++ b/CODE_OF_CONDUCT.rst @@ -0,0 +1,9 @@ +This project follows the `Google Open Source Community +Guidelines `__. + +A copy of these guidelines can be found locally in this repository at +`docs/open-source-pdks/code-of-conduct.rst <./docs/open-source-pdks/code-of-conduct.rst>`__. + +A copy of these guidelines are also `included in the published +documentation `__ +located at https://gf180mcu-pdk.rtfd.io. diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..0aec1e6 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,6 @@ +Guidelines for contributing can be found locally in this repository at +`docs/open-source-pdks/contributing.rst <./docs/open-source-pdks/contributing.rst>`__. + +A copy of these guidelines are also `included in the published +documentation `__ +located at https://gf180mcu-pdk.rtfd.io. diff --git a/docs/code-of-conduct.rst b/docs/code-of-conduct.rst deleted file mode 100644 index b0164f0..0000000 --- a/docs/code-of-conduct.rst +++ /dev/null @@ -1,68 +0,0 @@ -Google Open Source Community Guidelines ---------------------------------------- - -.. community_guidelines_text - -At Google, we recognize and celebrate the creativity and collaboration -of open source contributors and the diversity of skills, experiences, -cultures, and opinions they bring to the projects and communities they -participate in. - -Every one of Google's open source projects and communities are inclusive -environments, based on treating all individuals respectfully, regardless -of gender identity and expression, sexual orientation, disabilities, -neurodiversity, physical appearance, body size, ethnicity, nationality, -race, age, religion, or similar personal characteristic. - -We value diverse opinions, but we value respectful behavior more. - -Respectful behavior includes: - -- Being considerate, kind, constructive, and helpful. -- Not engaging in demeaning, discriminatory, harassing, hateful, - sexualized, or physically threatening behavior, speech, and imagery. -- Not engaging in unwanted physical contact. - -Some Google open source projects -`may adopt `__ -an explicit project code of conduct, which may have additional detailed -expectations for participants. Most of those projects will use our -`modified Contributor Covenant `__. - -Resolve peacefully -~~~~~~~~~~~~~~~~~~ - -We do not believe that all conflict is necessarily bad; healthy debate -and disagreement often yields positive results. However, it is never -okay to be disrespectful. - -If you see someone behaving disrespectfully, you are encouraged to -address the behavior directly with those involved. Many issues can be -resolved quickly and easily, and this gives people more control over the -outcome of their dispute. If you are unable to resolve the matter for -any reason, or if the behavior is threatening or harassing, report it. -We are dedicated to providing an environment where participants feel -welcome and safe. - -Reporting problems -~~~~~~~~~~~~~~~~~~ - -Some Google open source projects may adopt a project-specific code of -conduct. In those cases, a Google employee will be identified as the -Project Steward, who will receive and handle reports of code of conduct -violations. In the event that a project hasn't identified a Project -Steward, you can report problems by emailing opensource@google.com. - -We will investigate every complaint, but you may not receive a direct -response. We will use our discretion in determining when and how to -follow up on reported incidents, which may range from not taking action -to permanent expulsion from the project and project-sponsored spaces. We -will notify the accused of the report and provide them an opportunity to -discuss it before any action is taken. The identity of the reporter will -be omitted from the details of the report supplied to the accused. In -potentially harmful situations, such as ongoing harassment or threats to -anyone's safety, we may take action without notice. - -*This document was adapted from the* -`IndieWeb Code of Conduct `_ -*and can also be found at* . diff --git a/docs/contributing.rst b/docs/contributing.rst deleted file mode 100644 index 0d67502..0000000 --- a/docs/contributing.rst +++ /dev/null @@ -1,36 +0,0 @@ -How to Contribute -================= - -We'd love to accept your patches and contributions to this project. -There are just a few small guidelines you need to follow. - -Contributor License Agreement ------------------------------ - -Contributions to this project must be accompanied by a Contributor -License Agreement. You (or your employer) retain the copyright to your -contribution; this simply gives us permission to use and redistribute -your contributions as part of the project. Head over to -https://cla.developers.google.com/ to see your current agreements on -file or to sign a new one. - -You generally only need to submit a CLA once, so if you've already -submitted one (even if it was for a different project), you probably -don't need to do it again. - -Code reviews ------------- - -All submissions, including submissions by project members, require -review. We use GitHub pull requests for this purpose. Consult `GitHub -Help `__ for more -information on using pull requests. - -Community Guidelines --------------------- - -This project follows `Google's Open Source Community -Guidelines `__. - -.. include:: code-of-conduct - :start-after: community_guidelines_text diff --git a/docs/index.rst b/docs/index.rst index ca054b2..ee28238 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,13 +8,13 @@ Welcome to GlobalFoundries 0.18UM 3.3V/(5V)6V MCU PDK's documentation! .. toctree:: :hidden: - versioning - digital/Digital analog/Analog IPs/ips physical_verification/design_man + open-source-pdks/index + .. warning:: This documentation is currently a **work in progress**. diff --git a/docs/open-source-pdks b/docs/open-source-pdks new file mode 120000 index 0000000..e96c7b8 --- /dev/null +++ b/docs/open-source-pdks @@ -0,0 +1 @@ +../third_party/open-source-pdks/docs \ No newline at end of file diff --git a/docs/versioning.rst b/docs/versioning.rst deleted file mode 100644 index 3d6d391..0000000 --- a/docs/versioning.rst +++ /dev/null @@ -1,46 +0,0 @@ -.. include:: common.inc - -.. _Versioning Information: - -Versioning Information -====================== - -Current Status --------------- - -.. include:: status - :start-after: current_status_text - -Version Number Format ---------------------- - -Version numbers for both the PDK and the supplied libraries are fully specified by a 3-digit version number followed by a git commit count and a git commit short hash. - -The 3-digit-number will be tagged in the associated git repository as ``vX.Y.Z`` and the fully specified value can be found by running |git-describe|_ tool inside the correct git repository. - -.. |git-describe| replace:: ``git describe`` -.. _git-describe: https://git-scm.com/docs/git-describe - -The version number is broken down as ``vX.Y.Z-AAA-gHHHHH``; - -* The letter ``v``. - -* ``X`` = The "Milestone Release" Number - - * **0** indicates **"alpha"** level. The IP has **not** undergone full qualification. Parts of the IP **may be immature and untested**. - - * **1** indicates **"beta"** level. The IP has undergone qualification testing but has **not** been hardware verified. - - * **2** indicates **production** level. The IP has passed qualification testing and has been hardware verified. - -* ``Y`` = The "Major Release" Number - -* ``Z`` = The "Minor Release" Number - -* A single hyphen character ``-`` - -* ``AAA`` = The `git commit count `_ since the version number was tagged. - -* A single hyphen character followed by the letter g ``-g`` - -* ``HHHH`` = A `git commit short hash `_ which uniquely identifies a specific git commit inside the associated git repository. diff --git a/third_party/open-source-pdks b/third_party/open-source-pdks new file mode 160000 index 0000000..fd509b9 --- /dev/null +++ b/third_party/open-source-pdks @@ -0,0 +1 @@ +Subproject commit fd509b924cb902dd0650d04889a95072040144ee