diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..dd84ea7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/meeting.md b/.github/ISSUE_TEMPLATE/meeting.md new file mode 100644 index 0000000..6e286f0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/meeting.md @@ -0,0 +1,54 @@ +# [PROJECT NAME] TSC Meeting - <%= date.toFormat("MMMM d, yyyy") %> + +## Date/Time + +| Timezone | Date/Time | +|----------|-----------| +<%= [ + 'America/Los_Angeles', + 'America/Denver', + 'America/Chicago', + 'America/New_York', + 'Europe/London', + 'Europe/Amsterdam', + 'Asia/Shanghai', + 'Asia/Tokyo', +].map((zone) => { + return `| ${zone} | ${date.setZone(zone).toFormat('EEE dd-MMM-yyyy HH:mm (hh:mm a)')} |` +}).join('\n') %> + +Or in your local time: +* https://www.timeanddate.com/worldclock/?iso=<%= date.toFormat("yyyy-MM-dd'T'HH:mm:ss") %> + +All meetings are listed on the project calendar at https://lists.openmainframeproject.org/calendar, subject to the mailing lists you are subscribed to. + +### Conference call details + +_fill in Zoom details_ + +### Meeting recordings + +_fill in recording details_ + +## Attendance + +### Voting member rollcall: + +_fill in voting members as a checklist_ + +### Other Attendees + + +## Agenda + +Extracted from **<%= agendaLabel %>** labelled issues and pull requests from **<%= owner %>/<%= repo %>** prior to the meeting. + +* Project updates ( list at https://github.com/openmainframeproject/tac#tac-projects ) +<%= agendaIssues.map((i) => { + return `* ${i.title} [#${i.number}](${i.html_url})` +}).join('\n') %> + +## Action Items + + +## Notes diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000..b9689e7 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,29 @@ +# Description + +Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. + +Fixes # (issue) + +## Type of change + +Please delete options that are not relevant. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update + +# How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration + +# Checklist: + +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes +- [ ] Any dependent changes have been merged and published in downstream modules diff --git a/.github/workflows/create_agenda.yml b/.github/workflows/create_agenda.yml new file mode 100644 index 0000000..1e90879 --- /dev/null +++ b/.github/workflows/create_agenda.yml @@ -0,0 +1,18 @@ +# TODO: 'schedules' will need to be updated to coincide with the meeting frequency + +name: Schedule TSC meetings +on: + workflow_dispatch: +# schedule: +# - cron: '0 0 * * *' +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: pkgjs/meet + with: + token: ${{ secrets.GITHUB_TOKEN }} + schedules: 2020-05-14T17:00:00.0Z/P4W + createWithin: P1D + issueTitle: "TSC Meeting <%= date.toFormat('yyyy-MM-dd') %>" + agendaLabel: meeting-agenda diff --git a/.github/workflows/repolinter.yml b/.github/workflows/repolinter.yml new file mode 100644 index 0000000..239aeab --- /dev/null +++ b/.github/workflows/repolinter.yml @@ -0,0 +1,23 @@ +name: Weekly Lint repository +on: + schedule: + - cron: "0 0 * * 0" + workflow_dispatch: + +jobs: + repo-lint: + name: "repolint" + runs-on: ubuntu-latest + steps: + - name: "Checkout repo" + uses: actions/checkout@v2.0.0 + with: + fetch-depth: 0 + - name: "Install Node.js" + uses: actions/setup-node@v1 + with: + node-version: '12.x' + - name: "Install repolinter" + run: npm install -g todogroup/repolinter#080524e48d60f211895c3d7271133a4f2f9bf3c4 + - name: "Run repolinter" + run: repolinter lint --dryRun -g $GITHUB_SERVER_URL/$GITHUB_REPOSITORY diff --git a/.github/workflows/send_agenda.yml b/.github/workflows/send_agenda.yml new file mode 100644 index 0000000..810341e --- /dev/null +++ b/.github/workflows/send_agenda.yml @@ -0,0 +1,16 @@ +name: Send TSC meeting agenda to email list +on: + issues: + types: [opened] +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: timheuer/issue-notifier@v1 + env: + SENDGRID_API_KEY: ${{ secrets.SENDGRID_API_KEY }} + with: + fromMailAddress: 'tac@openmainframeproject.org' + toMailAddress: '[MAILING LIST EMAIL]' + subject: 'TSC meeting agenda' + labelsToMonitor: 'meeting' diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7427961 --- /dev/null +++ b/.gitignore @@ -0,0 +1,27 @@ +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..fd2a62f --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,14 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added + +### Changed + +### Removed diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..7635693 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1 @@ +All participants agree to abide by the Code of Conduct available at https://lfprojects.org/policies/code-of-conduct/. Please contact conduct@lfenergy.org to report any violations or concerns. diff --git a/COMMITTERS.csv b/COMMITTERS.csv new file mode 100644 index 0000000..4824ee9 --- /dev/null +++ b/COMMITTERS.csv @@ -0,0 +1 @@ +Name, Email, Github ID diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0e23a7f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,34 @@ +_Use this file to detail how to make a contribution to the project. The structure below is generally recommended, but can be changed to meet the needs of the project_ + +# Contributing to PROJECT NAME + +Thank you for your interest in contributing to PROJECT NAME. This document explains our contribution process and procedures: + +* [How to Contribute a Bug Fix or Change](#How-to-Contribute-a-Bug-Fix-or-Change) +* [Development Workflow](#Development-Workflow) +* [Coding Style](#Coding-Style) + +For a description of the roles and responsibilities of the various members of the PROJECT NAME community, see the [governance policies], and for further details, see the project's [Technical Charter]. Briefly, Contributors are anyone who submits content to the project, Committers review and approve such submissions, and the Technical Steering Committee provides general project oversight. + +If you just need help or have a question, refer to [SUPPORT.md](SUPPORT.md). + +## How to Contribute a Bug Fix or Change + +To contribute code to the project, first read over the [governance policies] page to understand the roles involved. + +Each contribution must meet the [coding style] and include.. + +* Tests and documentation to explain the functionality. +* Any new files have [copyright and license headers] +* A [Developer Certificate of Origin signoff]. +* Submitted to the project as a pull request. + +PROJECT NAME is licensed under the [LICENSE NAME](LICENSE.md) license. Contributions should abide by that standard license. + +Project committers will review the contribution in a timely manner, and advise of any changes needed to merge the request. + + +[governance policies]: GOVERNANCE.md +[Technical Charter]: tsc/CHARTER.md +[copyright and license headers]: https://github.com/lf-energy/tac/blob/main/process/contribution_guidelines.md#license +[Developer Certificate of Origin signoff]: https://github.com/lf-energy/tac/blob/main/process/contribution_guidelines.md#contribution-sign-off diff --git a/GOVERNANCE.md b/GOVERNANCE.md new file mode 100644 index 0000000..11a7936 --- /dev/null +++ b/GOVERNANCE.md @@ -0,0 +1,70 @@ +*NOTE: This document is intended to provide an example governance structure for any LF Energy Foundation project to consider as a starting point. All projects hosted by LF Energy Foundation are not bound by these governance polices, but in absence of any prior governance structure should consider this as a recommended structure* + +# Overview + +This project aims to be governed in a transparent, accessible way for the benefit of the community. All participation in this project is open and not bound to corporate affilation. Participants are bound to the project's [Code of Conduct]. + +# Project roles + +## Contributor + +The contributor role is the starting role for anyone participating in the project and wishing to contribute code. + +# Process for becoming a contributor + +* Review the [Contribution Guidelines] to ensure your contribution is inline with the project's coding and styling guidelines. +* Submit your code as a PR with the appropriate DCO signoff +* Have your submission approved by the committer(s) and merged into the codebase. + +## Committer + +The committer role enables the contributor to commit code directly to the repository, but also comes with the responsibility of being a responsible leader in the community. + +### Process for becoming a committer + +* Show your experience with the codebase through contributions and engagement on the community channels. +* Request to become a committer. To do this, create a new pull request that adds your name and details to the [Committers File] file and request existing committers to approve. +* After the majority of committers approve you, merge in the PR. Be sure to tag the whomever is managing the GitHub permissions to update the committers team in GitHub. + +### Committer responsibilities + +* Monitor email aliases (if any). +* Monitor Slack (delayed response is perfectly acceptable). +* Triage GitHub issues and perform pull request reviews for other committers and the community. +* Make sure that ongoing PRs are moving forward at the right pace or closing them. +* In general continue to be willing to spend at least 25% of ones time working on the project (~1.25 business days per week). + +### When does a committer lose committer status + +If a committer is no longer interested or cannot perform the committer duties listed above, they +should volunteer to be moved to emeritus status. In extreme cases this can also occur by a vote of +the committers per the voting process below. + +## Lead + +The project committers will elect a lead ( and optionally a co-lead ) which will be the primary point of contact for the project and representative to the TAC upon becoming an Active stage project. The lead(s) will be responsible for the overall project health and direction, coordination of activities, and working with other projects and committees as needed for the continuted growth of the project. + +# Release Process + +Project releases will occur on a scheduled basis as agreed to by the committers. + +# Conflict resolution and voting + +In general, we prefer that technical issues and committer membership are amicably worked out +between the persons involved. If a dispute cannot be decided independently, the committers can be +called in to decide an issue. If the committers themselves cannot decide an issue, the issue will +be resolved by voting. The voting process is a simple majority in which each committer receives one vote. + +# Communication + +This project, just like all of open source, is a global community. In addition to the [Code of Conduct], this project will: + +* Keep all communucation on open channels ( mailing list, forums, chat ). +* Be respectful of time and language differences between community members ( such as scheduling meetings, email/issue responsiveness, etc ). +* Ensure tools are able to be used by community members regardless of their region. + +If you have concerns about communication challenges for this project, please contact the committers. + +[Code of Conduct]: CODE_OF_CONDUCT.md +[Committers File]: COMMITTERS.csv +[Contribution Guidelines]: CONTRIBUTING.md diff --git a/INSTRUCTIONS.md b/INSTRUCTIONS.md new file mode 100644 index 0000000..4343cf4 --- /dev/null +++ b/INSTRUCTIONS.md @@ -0,0 +1,15 @@ +# Instructions for using this template + +1) Review and update (README.md) and (tsc/README.md) with the [PROJECT NAME] and [PROJECT LOGO], as well as the contents for the various sections. +2) To enable creating meeting agendas from GitHub issues, follow steps 3-5. +3) In the [meeting agenda template](.github/ISSUE_TEMPLATE/meeting.md), update `[PROJECT NAME]` and add the TSC members under the ['Attendance' section](.github/ISSUE_TEMPLATE/meeting.md#attendance). +4) Set the meeting date and time, along with the cadence in the [build agenda workflow](.github/workflows/build_agenda.yml) in the key `schedules:` that specifies a ISO-8601 interval. Examples for repeating: + +``` +# start 2020-04-22 at 16:00, repeat every 2 weeks +schedules: 2020-04-22T16:00:00.0Z/P2W +# start 2020-04-22 at 16:00, repeat every 7 days +schedules: 2020-06-22T16:00:00.0Z/P7D +``` +5) In the [send agenda workflow](.github/workflows/send_agenda.yml), update `[PROJECT NAME]` and `[MAILING LIST EMAIL]`. +6) Any items with the label `meeting` will be added to the agenda automatically when it is built the day prior to the meeting. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c43ce71 --- /dev/null +++ b/LICENSE @@ -0,0 +1,99 @@ +Creative Commons Attribution 4.0 International + +Creative Commons Corporation ("Creative Commons") is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an "as-is" basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses. + +Considerations for licensors: Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. More considerations for licensors : wiki.creativecommons.org/Considerations_for_licensors + +Considerations for the public: By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor's permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described. Although not required by our licenses, you are encouraged to respect those requests where reasonable. More considerations for the public : wiki.creativecommons.org/Considerations_for_licensees + +Creative Commons Attribution 4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions. + +Section 1 – Definitions. + +a. Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image. +b. Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License. +c. Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. +d. Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements. +e. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material. +f. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License. +g. Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license. +h. Licensor means the individual(s) or entity(ies) granting rights under this Public License. +i. Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them. +j. Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world. +k. You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning. +Section 2 – Scope. + +a. License grant. +1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to: +A. reproduce and Share the Licensed Material, in whole or in part; and +B. produce, reproduce, and Share Adapted Material. +2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions. +3. Term. The term of this Public License is specified in Section 6(a). +4. Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material. +5. Downstream recipients. +A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License. +B. No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material. +6. No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i). +b. Other rights. +1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise. +2. Patent and trademark rights are not licensed under this Public License. +3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties. +Section 3 – License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the following conditions. + +a. Attribution. +1. If You Share the Licensed Material (including in modified form), You must: +A. retain the following if it is supplied by the Licensor with the Licensed Material: +i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated); +ii. a copyright notice; +iii. a notice that refers to this Public License; +iv. a notice that refers to the disclaimer of warranties; +v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; +B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and +C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License. +2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information. +3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable. +4. If You Share Adapted Material You produce, the Adapter's License You apply must not prevent recipients of the Adapted Material from complying with this Public License. +Section 4 – Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material: + +a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database; +b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material; and +c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database. +For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights. + +Section 5 – Disclaimer of Warranties and Limitation of Liability. + +a. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You. +b. To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You. +c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability. +Section 6 – Term and Termination. + +a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically. +b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates: +1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or +2. upon express reinstatement by the Licensor. +c. For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License. +d. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License. +e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. +Section 7 – Other Terms and Conditions. + +a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed. +b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License. +Section 8 – Interpretation. + +a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License. +b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions. +c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor. +d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority. +Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the "Licensor." The text of the Creative Commons public licenses is dedicated to the public domain under the CC0 Public Domain Dedication. Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at creativecommons.org/policies, Creative Commons does not authorize the use of the trademark "Creative Commons" or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/README.md b/README.md new file mode 100644 index 0000000..2ce8f7a --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +```gfm +# insert project logo - replace the below logo location with the location of your logo +![](https://github.com/lf-energy/artwork/blob/master/projects/PROJECT NAME/PROJECT NAME-color.svg) +``` + +```gfm +# Add badges that point to your LICENSE, CII status, and build environment (if it exists). Check out other badges to add at https://shields.io/ +![GitHub](https://img.shields.io/github/license/lfenergy/PROJECT NAME) +[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/CII ID/badge)](https://bestpractices.coreinfrastructure.org/projects/CII ID) +``` + +# PROJECT NAME + +_2-3 sentence description of the project_ + +## Install + +_Provide install instructions here or point to an INSTALL.md file_ + +## Build + +_Provide build instructions here or point to an BUILD.md file_ + +## Discussion + +You can connect with the community in a variety of ways... + +- [LINK TO MAILING LIST](https://lists.lfenergy.org/g/xxxx-discussion) +- [#PROJECT NAME channel on LF Energy Slack](https://slack.lfenergy.org) + +## Contributing +Anyone can contribute to the PROJECT NAME project - learn more at [CONTRIBUTING.md](CONTRIBUTING.md) + +## Governance +PROJECT NAME is a project hosted by the [LF Energy Foundation](https://lfenergy.org). This project's techincal charter is located in [CHARTER.md](tsc/CHARTER.md) and has established it's own processes for managing day-to-day processes in the project at [GOVERNANCE.md](GOVERNANCE.md). + +## Reporting Issues +To report a problem, you can open an [issue](https://github.com/lf-energy/PROJECT NAME/issues) in repository against a specific workflow. If the issue is senstive in nature or a security related issue, please do not report in the issue tracker but instead email PROJECT NAME-private@lists.lfenergy.org. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..034e848 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,21 @@ +# Security Policy + +## Supported Versions + +Use this section to tell people about which versions of your project are +currently being supported with security updates. + +| Version | Supported | +| ------- | ------------------ | +| 5.1.x | :white_check_mark: | +| 5.0.x | :x: | +| 4.0.x | :white_check_mark: | +| < 4.0 | :x: | + +## Reporting a Vulnerability + +Use this section to tell people how to report a vulnerability. + +Tell them where to go, how often they can expect to get an update on a +reported vulnerability, what to expect if the vulnerability is accepted or +declined, etc. diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 0000000..fbd2a7e --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,27 @@ +_Use this file to detail how to make get support forthe project. The structure below is generally recommended, but can be changed to meet the needs of the project_ + +# Getting Help + +There are a few ways to connect with the PROJECT NAME project: + +* _provide email list details_ +* _provide Slack details_ +* _provide link to submit issue_ + +## How to Ask for Help + +If you have trouble installing, building, or using PROJECT NAME, but there's not yet reason to suspect you've encountered a genuine bug, +start by posting a question to the mailing list or Slack channel. This is the place for question such has "How do I...". + +## How to report a bug or request an enhancement + +PROJECT NAME manages bug and enhancement using it's [issue tracker]. The issue template will guide you on making an effective report. + +## How to report a security vulnerability + +If you think you've found a potential vulnerability in PROJECT NAME, please +email security@PROJECT DOMAIN to responsibly disclose it. + +## Contributing a fix + +Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) to make a project contribution. diff --git a/THIRD_PARTY.md b/THIRD_PARTY.md new file mode 100644 index 0000000..920c29f --- /dev/null +++ b/THIRD_PARTY.md @@ -0,0 +1 @@ +_Use this file to list out any third-party dependencies used by this project. You may choose to point to a Gemfile or other language specific packaging file for details._ diff --git a/tests/README.md b/tests/README.md new file mode 100644 index 0000000..f28541f --- /dev/null +++ b/tests/README.md @@ -0,0 +1 @@ +Any test for this project go in this folder. If there are no tests, please keep this folder to avoid repolinter errors and notate in this field why. diff --git a/tsc/CHARTER.md b/tsc/CHARTER.md new file mode 100644 index 0000000..420b987 --- /dev/null +++ b/tsc/CHARTER.md @@ -0,0 +1,69 @@ +_Template - update with Adopted Date when TSC approves and send to operations@lfenergy.org to file_ + +# Technical Charter (the "Charter") for [PROJECT NAME] a Series of LF Projects, LLC + +**Adopted [DATE]** + +This charter (the "Charter") sets forth the responsibilities and procedures for technical contribution to, and oversight of, the [PROJECT NAME] project, which has been established as [PROJECT NAME] a Series of LF Projects, LLC (the "Project"). LF Projects, LLC ("LF Projects") is a Delaware series limited liability company. All Contributors to the Project must comply with the terms of this Charter. + +## 1. Mission and Scope of the Project + * **a.** The mission of the Project is [MISSION]. + * **b.** The scope of the Project includes software development under an OSI-approved open source license supporting the mission, including documentation, testing, integration and the creation of other artifacts that aid the development, deployment, operation or adoption of the open source software project. + +## 2. Technical Steering Committee + * **a.** The Technical Steering Committee (the "TSC") will be responsible for all technical oversight of the open source Project. + * **b.** The TSC voting members are initially the Project's Committers. At the inception of the project, the Committers of the Project will be as set forth within the "CONTRIBUTING" file within the Project's code repository. The TSC may choose an alternative approach for determining the voting members of the TSC, and any such alternative approach will be documented in the CONTRIBUTING file. Any meetings of the Technical Steering Committee are intended to be open to the public, and can be conducted electronically, via teleconference, or in person. + * **c.** TSC projects generally will involve Contributors and Committers. The TSC may adopt or modify roles so long as the roles are documented in the CONTRIBUTING file. Unless otherwise documented: + * **i.** Contributors include anyone in the technical community that contributes code, documentation, or other technical artifacts to the Project; + * **ii.** Committers are Contributors who have earned the ability to modify ("commit") source code, documentation or other technical artifacts in a project's repository; and + * **iii.** A Contributor may become a Committer by a majority approval of the existing Committers. A Committer may be removed by a majority approval of the other existing Committers. + * **d.** Participation in the Project through becoming a Contributor and Committer is open to anyone so long as they abide by the terms of this Charter. + * **e.** The TSC may (1) establish work flow procedures for the submission, approval, and closure/archiving of projects, (2) set requirements for the promotion of Contributors to Committer status, as applicable, and (3) amend, adjust, refine and/or eliminate the roles of Contributors, and Committers, and create new roles, and publicly document any TSC roles, as it sees fit. + * **f.** The TSC may elect a TSC Chair, who will preside over meetings of the TSC and will serve until their resignation or replacement by the TSC. The TSC Chair, or any other TSC member so designated by the TSC, will serve as the primary communication contact between the Project and the Technical Advisory Council of the Academy Software Foundation of The Linux Foundation. + * **g.** Responsibilities: The TSC will be responsible for all aspects of oversight relating to the Project, which may include: + * **i.** coordinating the technical direction of the Project; + * **ii.** approving project or system proposals (including, but not limited to, incubation, deprecation, and changes to a sub-project's scope); + * **iii.** organizing sub-projects and removing projects; + * **iv.** creating sub-committees or working groups to focus on cross-project technical issues and requirements; + * **v.** appointing representatives to work with other open source or open standards communities; + * **vi.** establishing community norms, workflows, issuing releases, and security issue reporting policies; + * **vii.** approving and implementing policies and processes for contributing (to be published in the CONTRIBUTING file) and coordinating with the Series Manager to resolve matters or concerns that may arise as set forth in Section 7 of this Charter; + * **viii.** discussions, seeking consensus, and where necessary, voting on technical matters relating to the code base that affect multiple projects; and + * **ix.** coordinating any marketing, events, or communications regarding the Project with the LF Projects Manager or their designee. + +## 3. TSC Voting + * **a.** While the Project aims to operate as a consensus based community, if any TSC decision requires a vote to move the Project forward, the voting members of the TSC will vote on a one vote per voting member basis. + * **b.** Quorum for TSC meetings requires at least two-thirds of all voting members of the TSC to be present. The TSC may continue to meet if quorum is not met, but will be prevented from making any decisions at the meeting. + * **c.** Except as provided in Section 7.c. and 8.a, decisions by vote at a meeting require a majority vote of those in attendance, provided quorum is met. Decisions made by electronic vote without a meeting require a majority vote of all voting members of the TSC. + * **d.** In the event a vote cannot be resolved by the TSC, any voting member of the TSC may refer the matter to the Series Manager for assistance in reaching a resolution. + +## 4. Compliance with Policies + * **a.** This Charter is subject to the Series Agreement for the Project and the Operating Agreement of LF Projects. Contributors will comply with the policies of LF Projects as may be adopted and amended by LF Projects, including, without limitation the policies listed at https://lfprojects.org/policies/. + * **b.** The TSC may adopt a code of conduct ("CoC") for the Project, which is subject to approval by the Series Manager. Contributors to the Project will comply with the CoC or, in the event that a Project-specific CoC has not been approved, the LF Projects Code of Conduct listed at https://lfprojects.org/policies/. + * **c.** When amending or adopting any policy applicable to the Project, LF Projects will publish such policy, as to be amended or adopted, on its web site at least 30 days prior to such policy taking effect; provided, however, that in the case of any amendment of the Trademark Policy or Terms of Use of LF Projects, any such amendment is effective upon publication on LF Projects web site. + * **d.** All participants must allow open participation from any individual or organization meeting the requirements for contributing under this Charter and any policies adopted for all participants by the TSC, regardless of competitive interests. Put another way, the Project community must not seek to exclude any participant based on any criteria, requirement, or reason other than those that are reasonable and applied on a non-discriminatory basis to all participants in the Project community. + * **e.** The Project will operate in a transparent, open, collaborative, and ethical manner at all times. The output of all Project discussions, proposals, timelines, decisions, and status should be made open and easily visible to all. Any potential violations of this requirement should be reported immediately to the LF Projects Manager. + +## 5. Community Assets + * **a.** LF Projects shall hold title to all trade or service marks used by the Project ("Project Trademarks"), whether based on common law or registered rights. Project Trademarks shall be transferred and assigned to LF Projects to hold on behalf of the Project. Any use of any Project Trademarks by participants in the Project shall be in accordance with the license from LF Projects and inure to the benefit of LF Projects. + * **b.** The Project shall, as permitted and in accordance with such license from LF Projects, develop and own all Project GitHub and social media accounts, and domain name registrations created by the Project community. + * **c.** Under no circumstances shall LF Projects be expected or required to undertake any action on behalf of the Project that is inconsistent with the tax-exempt status or purpose, as applicable, of LFP, Inc. or LF Projects, LLC. + +## 6. General Rules and Operations. + * **a.** The Project will: + * **i.** engage in the work of the project in a professional manner consistent with maintaining a cohesive community, while also maintaining the goodwill and esteem of LF Projects, LFP, Inc. and other partner organizations in the open source software community; and + * **ii.** respect the rights of all trademark owners, including any branding and trademark usage guidelines. + +## 7. Intellectual Property Policy + * **a.** Participants acknowledge that the copyright in all new contributions shall be retained by the copyright holder as independent works of authorship and that no contributor or copyright holder will be required to assign copyrights to the Project. + * **b.** Except as described in Section 7.c., all code contributions to the Project are subject to the following: + * **i.** All new inbound code contributions to the Project must be made using the **[Apache License, Version 2.0 (available here: https://www.apache.org/licenses/LICENSE-2.0)]** (the "Project License"). + * **ii.** All new inbound code contributions must be accompanied by a Developer Certificate of Origin (http://developercertificate.org) sign-off in the source code system that is submitted through a TSC-approved contribution process which will bind the authorized contributor and, if not self-employed, their employer to the applicable license; + * **iii.** All outbound code will be made available under the Project License. + * **iv.** Documentation will be received and made available by the Project under the Creative Commons Attribution 4.0 International License (available at http://creativecommons.org/licenses/by/4.0/). + * **v.** The Project may seek to integrate and contribute back to other open source projects ("Upstream Projects"). In such cases, the Project will conform to all license requirements of the Upstream Projects, including dependencies, leveraged by the Project. Upstream Project code contributions not stored within the Project's main code repository shall comply with the contribution process and license terms for the applicable Upstream Project. + * **c.** If an alternative inbound or outbound license is required for compliance with the license for a leveraged open source project or is otherwise required to achieve the Project's mission, the Governing Board of the Academy Software Foundation of The Linux Foundation ("Governing Board") or the Governing Board's designated committee may approve the use of an alternative license for specific inbound or outbound contributions on an exception basis. Any exceptions must be approved by a vote of the Governing Board and must be limited in scope to what is required for such purpose. To request an exception, please describe the contribution, the alternative open source license(s), and the justification for using an alternative open source license for the Project. + * **d.** Contributed files should contain license information, such as SPDX short form identifiers, indicating the open source license or licenses pertaining to the file. + +## 8. Amendments + * **a.** This charter may be amended by a two-thirds vote of the entire TSC and is subject to approval by LF Projects. diff --git a/tsc/README.md b/tsc/README.md new file mode 100644 index 0000000..104fd7d --- /dev/null +++ b/tsc/README.md @@ -0,0 +1,68 @@ +# TSC Materials for [PROJECT NAME] + +This directory contains the meeting notes, process documentations, and other materials related to this project. + +## Project Intake checklist + +This is a checklist for TSC's to review as part of the intake process. The TSC should review this entire list during the kickoff meeting. For anything outstanding, create an [issue](../issues) to track and link to it in the list + +- Codebase + - [ ] Project license identified and exists in root directory of all repos ( named LICENSE ) + - [ ] Code scan completed and any recommendations remedyed. +- TSC Record Keeping + - [ ] Location for TSC documents and meeting notes ( recommendation is ```tsc``` directory in main repo, and then ```meetings``` under the ```tsc``` directory ) + - [ ] Copy this checklist to the above location for tracking +- Existing Project Governance + - [ ] README.md file exists ( template started at [README.md](../README.md) ) + - [ ] Any third-party components/dependencies included are listed along with thier licenses ( example template at [THIRD_PARTY.md](../THIRD_PARTY.md) ) + - [ ] Governamce defined, outlining community roles and how decsions are made ( starting point at [GOVERNANCE.md](../GOVERNANCE.md) if needed ). + - [ ] Contribution Policy defined ( CONTRIBUTING.md ) + - [ ] Code of Conduct defined ( default is at [CODE_OF_CONDUCT.md](../CODE_OF_CONDUCT.md) - if using a different code of conduct please contact [LFE Staff](mailto:operations@lfenergy.org) ). + - [ ] Release methodology defined ( [RELEASE.md](../RELEASE.md) ) +- New Project Goverance + - [ ] TSC members identified, added to [GOVERNANCE.md](../GOVERNANCE.md). + - [ ] First TSC meeting held ( [agenda](meetings) ) + - [ ] TSC meeting cadence set and added to project calendar (https://lists.lfenergy.org/calendar) +- Infrastructure + - [ ] Source Control (Github, GitLab, something else ) and LFE Staff is an administrator. + - [ ] Developer Certificate of Origin past commit signoff done and DCO Probot enabled. + - [ ] Issue/feature tracker (JIRA, GitHub issues) and LFE Staff is an administrator. + - Collaboration tools + - [ ] Mailing lists - one of: + - [ ] Create new list(s) ( default is -discussion@ and -private@ - create [service desk request] to provision ) + - [ ] Move to groups.io ( create [service desk request] to setup/transfer ) + - [ ] Establish project calendar on groups.io ( refer to [tac guidelines]) + - [ ] Slack or IRC ( create [service desk request] to setup Slack project channel ) + - [ ] Website ( refer to [tac guidelines] ) + - [ ] CI/build environment + - [ ] Add project to [Dev Anayltics](https://lfanalytics.io/projects/lf-energy) ( create [service desk request] to trigger ) +- Project assets + - [ ] Domain name ( create [service desk request] to setup/transfer ) + - [ ] Social media accounts ( create [service desk request] to setup/transfer ) + - [ ] Logo(s) ( create [service desk request] to create]; will be added to [artwork repo](https://artwork.lfenergy.org) in SVG and PNG format and color/black/white ) + - [ ] Trademarks/mark ownership rights ( complete [LF Projects - Form of Trademark and Account Assignment](lf_projects_trademark_assignment.md) ) +- Outreach + - [ ] New project annoucement done ( create [service desk request] to trigger ) + - [ ] Project added to LF Energy website and LF Energy landscape +- Early Adoption requirements + - [ ] CII Badge achieved ( apply at https://bestpractices.coreinfrastructure.org/en ) + - [ ] Elect TSC Chairperson + - [ ] Regular cadence of TSC meetings being held. + - [ ] Governance defined at [GOVERNANCE.md](../GOVERNANCE.md). + - [ ] Used in production by 2 organizations ( identify in [ADOPTERS.csv](../ADOPTERS.csv) ) + - Growth plan + - [ ] Growth plan created ( put in [growth-plan.md](growth-plan.md)) + - [ ] Growth plan submitted to TAC ( create [tac issue] to request - link to [growth-plan.md](growth-plan.md) + - [ ] Growth plan approved by TAC ( link to meeting minutes or email thread ) + - [ ] Commit/Contribution growth during incubation + - [ ] Schedule presentation to TAC + - [ ] TAC approval (2/3 required) +- Graduated Project requirements + - [ ] TSC established with 5+ members, with no more than 1/2 of members at the same organization. + - [ ] Release/Testing process defined ( [RELEASE.md](../RELEASE.md) )ocumented zCommitters defined in the project ( [COMMITTERS.csv](COMMITTERS.csv) or [COMMITTERS.yml](COMMITTERS.yml) ) + - [ ] Maintainers/committers from at least 2 organizations. + - [ ] Schedule presentation to TAC + - [ ] TAC approval (2/3 required) + +[service desk request]: https://github.com/lf-energy/foundation/issues/new/choose +[tac guidelines]: https://github.com/lf-energy/tac diff --git a/tsc/meetings/README.md b/tsc/meetings/README.md new file mode 100644 index 0000000..1d269fc --- /dev/null +++ b/tsc/meetings/README.md @@ -0,0 +1,3 @@ +# TSC Meeting notes + +All TSC meeting notes are stored here in YYYY-MM-DD.md format. Recordings and other assets from conference calls systems can also be stored in YYYY-MM-DD.XXX format.