Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create CONTRIBUTING.md #4

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Create CONTRIBUTING.md #4

wants to merge 1 commit into from

Conversation

ijmitch
Copy link
Contributor

@ijmitch ijmitch commented Jan 18, 2023

Signed-off-by: Ian J Mitchell [email protected]

Signed-off-by: Ian J Mitchell <[email protected]>
@ijmitch
Copy link
Contributor Author

ijmitch commented Jan 19, 2023

I took https://github.com/zowe/docs-site/blob/master/README.md as the starting point on the assumption we aim to adopt the Zowe docs contribution process.

I removed the Zowe references and also commented out some of sections - not wanting to remove them entirely as they may become relevant as we mature the process.

@ijmitch ijmitch self-assigned this Jan 19, 2023
@rpomp
Copy link

rpomp commented Feb 3, 2023

Below is the proposed description for the modernization WG

Modernization Definition and First Principles 01-13-23v2.docx

@ijmitch
Copy link
Contributor Author

ijmitch commented Feb 15, 2023

@rpomp Let's use #6 to evolve the definition.

I copied the Word doc into #5 and the content into a new branch which is the subject of the PR.

@ijmitch ijmitch marked this pull request as ready for review February 15, 2023 11:16
@rpomp
Copy link

rpomp commented Feb 15, 2023 via email

@ijmitch
Copy link
Contributor Author

ijmitch commented Feb 16, 2023

This is not the correct PR to discuss the definition... please use #6.

@ijmitch ijmitch requested a review from MistyDecker March 15, 2023 17:17
@ijmitch
Copy link
Contributor Author

ijmitch commented Mar 15, 2023

@MistyDecker ... this would be a good candidate for a first review/approval.

@ijmitch
Copy link
Contributor Author

ijmitch commented Mar 15, 2023

@qmangus , @rpomp - would you be OK if I deleted your comments which are unrelated to this PR?

(ie. The three immediately prior to the one I made pointing to the other PR )

@qmangus
Copy link

qmangus commented Mar 15, 2023

Done

Copy link
Collaborator

@MistyDecker MistyDecker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ian - did I do the review right?

CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
- You can rate the topic at the bottom of each page to tell us whether it is helpful.
- If you have a question about docs, you can join the Zowe [#zowe-doc Slack channel](https://openmainframeproject.slack.com/archives/CC961JYMQ) to reach out to the Zowe Doc Squad and the community.

Only file issues about Zowe docs in this repository. For issues, questions, new feature requests, or enhancement ideas about a specific component or aspect of Zowe, open an issue in the [corresponding code repository](https://github.com/zowe/community#zowe-sub-projects) or ask in the [community Slack channels](https://github.com/zowe/community#slack).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This process would be different for us, wouldn't it?

-->
## Contributing to the project

You can click the **Fork** button in the upper-right area of the screen to create a copy of this repository in your GitHub account. You can make content contributions in your fork, and when the changes are ready, go to your fork and create a new pull request to send the changes to us.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want people to Fork in this project?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a public project, I don't think we can deny the possibility of forking.

For more information about contributing to the Zowe documentation, see:
- [Zowe documentation style guide](https://docs.zowe.org/stable/contribute/contributing#documentation-style-guide)
-->
<!-- let's investigate whether we need signoffs
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is our signoff process? We should publish it here.
What is a DCO? I don't think that applies here, does it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rpomp
Copy link

rpomp commented Mar 15, 2023 via email

@MistyDecker
Copy link
Collaborator

I took https://github.com/zowe/docs-site/blob/master/README.md as the starting point on the assumption we aim to adopt the Zowe docs contribution process.

I removed the Zowe references and also commented out some of sections - not wanting to remove them entirely as they may become relevant as we mature the process.

I made some comments but I'm not sure I did it right. I'm not 100% sure I recognize a comment in this file format. And even if it's just a comment, I would lean towards removing them all together for V1 of our document so that newbs like me don't get confused. :-)

Did I do what you need me to? Sorry, I'm still so clueless about this process.

@ijmitch
Copy link
Contributor Author

ijmitch commented Mar 16, 2023

Comments were fine... I've responded to the ones about the Zowe links. They're in sections which I've commented out for now in anticipation that we would discuss and agree the finer aspects of contribution.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants