Merge pull request #219 from tanto259/update-governance

Update Governance Files
openmainframeproject · Dec 9, 2021 · 8911159 · 8911159
2 parents ecbd505 + 241afb1
commit 8911159
Show file tree

Hide file tree

Showing 13 changed files with 195 additions and 25 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,46 @@
+name: Bug Report
+description: Create a report to help us improve the COBOL Programming Course
+labels: ['bug']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for submitting a bug report. Please fill in the information below and we will get back to you as soon as possible.
+
+        Before opening an issue, please search our existing issues: https://github.com/openmainframeproject/cobol-programming-course/issues. 
+  - type: dropdown
+    attributes:
+      label: Course Details
+      description: Where did you take the course?
+      options:
+        - GitHub
+        - IBM Learning Platform
+        - Coursera
+        - edX
+        - Pluralsight
+        - YouTube
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Description
+      description: What happened? 
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Reproduction Steps
+      description: What do we need to do to reproduce this bug?
+      value: |
+        1.
+        2.
+        3.
+        ...
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Additional Context
+      description: Any other context about the problem?
+    validations:
+      required: false
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Slack Channel
+    url: https://slack.openmainframeproject.org
+    about: Need assistance on the course or just want to say hi? Join our Slack channel
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,41 @@
+name: Feature Request
+description: Suggest an idea for the COBOL Programming Course
+labels: ['enhancement']
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for submitting a feature request. Please fill in the information below and we will get back to you as soon as possible.
+  
+        Before opening a feature request, please search our existing issues: https://github.com/openmainframeproject/cobol-programming-course/issues. 
+  - type: dropdown
+    attributes:
+      label: Course Details
+      description: Where did you take the course?
+      options:
+        - GitHub
+        - IBM Learning Platform
+        - Coursera
+        - edX
+        - Pluralsight
+        - YouTube
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Description
+      description: Describe what you want to happen. 
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Problems
+      description: Is your feature request related to a problem? Please describe.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Additional Context
+      description: Any other context about the problem?
+    validations:
+      required: false
diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
@@ -0,0 +1,26 @@
+## Proposed changes
+
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context to communicate to the maintainers why we should accept this pull request.
+
+Fixes # (issue)
+
+## Type of change
+
+What type of changes does your PR introduce to the COBOL Programming Course? _Put an `x` in the boxes that apply._
+
+- [ ] Bug fix (change which fixes one or more issues)
+- [ ] New feature (change which adds functionality or features to the course)
+- [ ] Translations (change which adds or modifies translations of the course)
+- [ ] Documentation (change which modifies documentation related to the course)
+- [ ] This change requires an update to the course's z/OS environment
+
+## Checklist:
+
+_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This checklist will be used as reference for both the contributor and the reviewer_
+
+- [ ] I have read the [Contributing Guideline](https://github.com/openmainframeproject/cobol-programming-course/blob/master/CONTRIBUTING.md)
+- [ ] I have included a title and description for this PR
+- [ ] I have DCO-signed all of my commits that are included in this PR
+- [ ] I have tested it manually and there are no regressions found
+- [ ] I have commented my code, particularly in hard-to-understand areas (if appropriate)
+- [ ] I have made corresponding changes to the documentation (if appropriate)
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -1 +1 @@
-All participants agree to abide by the Code of Conduct available at https://github.com/openmainframeproject/tac/blob/master/CODE_OF_CONDUCT.md.
+All participants agree to abide by the Code of Conduct available at https://github.com/openmainframeproject/tac/blob/master/CODE_OF_CONDUCT.md. Please contact conduct@openmainframeproject.org to report any violations or concerns.
diff --git a/COMMITTERS.csv b/COMMITTERS.csv
@@ -1,10 +1,10 @@
-Name,Email,GitHub ID
-Sudharsana Srinivasan,Sudharsana.Srinivasan@ibm.com,Sudharsana-Srinivasan
-Martin Keen,mkeen@us.ibm.com,martinkeen
-John Mertic,jmertic@linuxfoundation.org,jmertic
-Paul Newton,paulnewt@us.ibm.com,paulnewt
-Michael Bauer,Michael.Bauer2@broadcom.com,MikeBauerCA
-Jessielaine Punongbayan,Jessielaine.Punongbayan@broadcom.com,jellypuno
-Zeibura Kathau,Zeibura.Kathau@broadcom.com,zeibura
-Hartanto Ario Widjaya,hartanto@securitypuppy.com,tanto259
-Joe Winchester,winchest@uk.ibm.com,Joe-Winchester
+Name,Email,GitHub ID,Role
+Sudharsana Srinivasan,Sudharsana.Srinivasan@ibm.com,Sudharsana-Srinivasan,Lead
+Michael Bauer,Michael.Bauer2@broadcom.com,MikeBauerCA,Co-Lead
+Martin Keen,mkeen@us.ibm.com,martinkeen,
+John Mertic,jmertic@linuxfoundation.org,jmertic,
+Paul Newton,paulnewt@us.ibm.com,paulnewt,
+Jessielaine Punongbayan,Jessielaine.Punongbayan@broadcom.com,jellypuno,
+Zeibura Kathau,Zeibura.Kathau@broadcom.com,zeibura,
+Hartanto Ario Widjaya,hartanto@securitypuppy.com,tanto259,
+Joe Winchester,winchest@uk.ibm.com,Joe-Winchester,
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -39,4 +39,4 @@ If you are committing via the GitHub UI directly, check out these [useful tools]
 
 ## Pull Requests
 - All contributions must be reviewed by a [committer](COMMITTERS.csv) 
-- Anyone can comment on a pull request to request delay on merging or to get questions answered.
+- Anyone can comment on a pull request to request delay on merging or to get questions answered.
diff --git a/GOVERNANCE.md b/GOVERNANCE.md
@@ -2,17 +2,17 @@
 
 # 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](CODE_OF_CONDUCT.md).
+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 affiliation. Participants are bound to the project's [Code of Conduct](CODE_OF_CONDUCT.md).
 
 # 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
+### Process for becoming a contributor
 
-* Review the [contribution guidelines](CONTRIBUTING.md) guidelines to ensure your contribution is inline with the project's coding and styling guidelines.
+* Review the [contribution guidelines](CONTRIBUTING.md) guidelines to ensure your contribution is in line with the project's coding and styling guidelines.
 * Submit your code as a [pull request](https://github.com/openmainframeproject/cobol-programming-course/pulls) with the appropriate [DCO signoff](https://github.com/openmainframeproject/tac/blob/master/process/contribution_guidelines.md#developer-certificate-of-origin)
 * Have your submission approved by the committer(s) and merged into the codebase.
 
@@ -25,7 +25,7 @@ The committer role enables the contributor to commit code directly to the reposi
 * Show your experience with the codebase through contributions and engagement on the community channels.
 * Request to become a committer.
 * Have the majority of committers approve you becoming a committer.
-* Your name and email is added to the [COMMITTERS.csv](COMMITTERS.csv) file for the project.
+* Your name and email are added to the [COMMITTERS.csv](COMMITTERS.csv) file for the project.
 
 ### Committer responsibilities
 
@@ -36,11 +36,11 @@ The committer role enables the contributor to commit code directly to the reposi
 
 ### 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.
+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.
+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 continued growth of the project.
 
 # Release Process
 
@@ -54,7 +54,7 @@ In general, we prefer that technical issues and committer membership are amicabl
 
 This project, just like all of open source, is a global community. In addition to the [Code of Conduct](CODE_OF_CONDUCT.md), this project will:
 
-* Keep all communucation on open channels ( mailing list, forums, chat ).
+* Keep all communication 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.
 

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-![](https://github.com/openmainframeproject/artwork/raw/master/projects/cobol-programming-course/cobol-programming-course-color.png)
+[![Logo](https://raw.githubusercontent.com/openmainframeproject/artwork/main/projects/cobol-pc/horizontal/color/cobol-pc-horizontal-color.png)](https://www.openmainframeproject.org/projects/cobolprogrammingcourse)
 
-![License](https://img.shields.io/github/license/OpenMainframeProject/cobol-programming-course)
+[![License](https://img.shields.io/github/license/OpenMainframeProject/cobol-programming-course)](LICENSE)
 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/4770/badge)](https://bestpractices.coreinfrastructure.org/projects/4770)
 
 # COBOL Programming Course
@@ -14,7 +14,7 @@ This project is a set of training materials and labs for COBOL on z/OS. The foll
     - [COBOL Programming Course #2 - Advanced Topics](COBOL%20Programming%20Course%20%232%20-%20Advanced%20Topics/README.md)
     - [COBOL Programming Course #3 - Testing](COBOL%20Programming%20Course%20%233%20-%20Testing/README.md)
 
-If you run into any issues, please don't hesitate to reach out on our [slack channel](https://openmainframeproject.slack.com/archives/C011NE32Z1T).
+If you run into any issues, please don't hesitate to reach out on our [Slack channel](https://openmainframeproject.slack.com/archives/C011NE32Z1T).
 
 ## Discussion
 
@@ -38,7 +38,7 @@ This project is openly governed as defined in [GOVERNANCE.md](GOVERNANCE.md).
 
 ## Credits
 
-The courseware materials were made available through a joint collaboration IBM, it's clients, and American River College and proposed as a new project by IBM.
+The courseware materials were made available through a joint collaboration between IBM, its clients, and American River College and proposed as a new project by IBM.
 
 ## Video Course Links
 

diff --git a/RELEASE.md b/RELEASE.md
@@ -1,5 +1,5 @@
 # Release guidelines
 
-This project is generally a rolling release project ( meaning the latest HEAD of master is the current materials ), but generally it's advised that those looking to leverage these materials in something downstream ( such as other training materials or labs enviroments ) pull from the [latest release tag](https://github.com/openmainframeproject/cobol-programming-course/releases) which makes it easier to see where the materials derived from.
+This project is generally a rolling release project ( meaning the latest HEAD of master is the current materials ), but generally, it's advised that those looking to leverage these materials in something downstream ( such as other training materials or labs environments ) pull from the [latest release tag](https://github.com/openmainframeproject/cobol-programming-course/releases) which makes it easier to see where the materials derived from.
 
-Releases are cut usually once a month from the then current HEAD of master, and provided as pdfs and source code only.
+Releases are cut usually once a month from the then-current HEAD of master and provided as PDFs and source code only.
diff --git a/ROADMAP.md b/ROADMAP.md
@@ -0,0 +1,20 @@
+# Roadmap
+
+This roadmap lists out the possible and planned future contents for the COBOL Programming Course. If you are interested in contributing content, please review our [contribution guidelines](https://github.com/openmainframeproject/cobol-programming-course/blob/master/CONTRIBUTING.md).
+
+## In-Progress Future Contents
+
+- COBOL Interaction with CICS
+- VSAM File Handling
+- Object-Oriented COBOL
+- Subprograms
+- Sorting and Merging
+
+## Possible Future Contents
+
+- COBOL Interaction with IMS
+- COBOL Development in Mixed AMODE LE
+- COBOL Dynamic Link Libraries
+- Communication with Java Methods
+- Debugging and Testing
+- Processing JSON and XML
diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,13 @@
+# Security Policy
+
+## Considerations
+
+The COBOL Programming Course does not produce any kind of software. This project produces a technical course aimed to educate people on COBOL programming. The output of this project is in the form of PDF documents detailing the course content. A Markdown version is also available on the repository.
+
+## Supported Version
+
+Only the [latest version](https://github.com/openmainframeproject/cobol-programming-course/releases/latest) of the course is supported.
+
+## Reporting a Vulnerability
+
+If you are aware of any significant vulnerability, or evidence of any, please send an email to the security contacts and we'll respond as soon as possible. For now, the security contacts are Michael Bauer, Hartanto Ario Widjaya and Sudharsana Srinivasan. The security contacts' email addresses can be found on the [COMMITTERS.csv](https://github.com/openmainframeproject/cobol-programming-course/blob/master/COMMITTERS.csv) file.
diff --git a/SUPPORT.md b/SUPPORT.md
@@ -0,0 +1,19 @@
+# Getting Help
+
+There are a few ways to connect with the COBOL Programming Course project:
+
+* [#cobol-programming-course channel on Open Mainframe Project Slack](https://slack.openmainframeproject.org)
+* [COBOL Programming Course Discussion Mailing list](https://lists.openmainframeproject.org/g/cobol-course-discussion)
+* [COBOL Programming Course GitHub issue tracker](https://github.com/openmainframeproject/cobol-programming-course/issues/new/choose)
+
+## How to Ask for Help
+
+If you have trouble installing, building, or using COBOL Programming Course, but there's not yet reason to suspect you've encountered a genuine bug, start by posting a question to the Slack channel. This is the place for questions such as "How do I...".
+
+## How to report a bug or request an enhancement
+
+COBOL Programming Course manages bug and enhancement using its [issue tracker](https://github.com/openmainframeproject/cobol-programming-course/issues/new/choose). The issue template will guide you in making an effective report.
+
+## Contributing a fix
+
+Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) to make a project contribution.