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

Update contributing.md to specify the Changelog.md format #1898

Closed
zFernand0 opened this issue Apr 6, 2022 · 5 comments
Closed

Update contributing.md to specify the Changelog.md format #1898

zFernand0 opened this issue Apr 6, 2022 · 5 comments
Labels
dev-doc documentation enhancement New feature or request priority-low Legit issue but cosmetic or nice-to-have

Comments

@zFernand0
Copy link
Member

zFernand0 commented Apr 6, 2022

If this (i.e. using past-tense in changelog.md) is a standard it should be documented in contributing.md. if it is, it's fine to link it

Originally posted by @dkelosky in zowe/imperative#721 (comment)

@t1m0thyj
Copy link
Member

t1m0thyj commented Apr 7, 2022

This is mentioned in CONTRIBUTING.md in the Zowe CLI repo:

Start the sentence with a verb in past tense. For example "Added...", "Improved...", "Enhanced...".

Admittedly this info is kind of hard to find, since I don't believe other repos like Imperative link mention this in their CONTRIBUTING.md. Maybe they should link to the file in the Zowe CLI repo?

@dkelosky
Copy link
Contributor

dkelosky commented Apr 7, 2022

I'd argue that the info isn't hard to find; rather, I thought they were unconnected. If they are linked, it would be great to know which sections (I assume not all) of Zowe CLI CONTRIBUTING.md apply to imperative's CONTRIBUTING.md.

Thanks!

@zFernand0
Copy link
Member Author

Since it's documented already in the Readme, should we close this issue.
Or do we want to re-use it to implement a PR Template that reminds people of a few key items (like the past tense in the changelogs) when they open a PR.

@dkelosky
Copy link
Contributor

dkelosky commented Apr 13, 2022

Can you clarify what s already documented in the README? I was mentioning that there is a Zowe CLI CONTRIBUTING.md and an Imperative CONTRIBUTING.md. It looks like only the Zowe CLI version mentions past tense. Thanks!

@zFernand0 zFernand0 added enhancement New feature or request documentation priority-low Legit issue but cosmetic or nice-to-have labels Nov 29, 2022
@awharn awharn transferred this issue from zowe/imperative Nov 13, 2023
@ATorrise ATorrise linked a pull request Dec 1, 2023 that will close this issue
@t1m0thyj t1m0thyj moved this to Low Priority in Zowe CLI Squad Dec 26, 2023
@zFernand0 zFernand0 changed the title Update contributing.md to specify the Chanlog.md format Update contributing.md to specify the Changelog.md format Oct 25, 2024
@zFernand0
Copy link
Member Author

After combining Imperative into the CLI, I believe we've also consolidated the contributing.md files.
So, the imperative contributing.md shouldn't be referenced since the repo is now a public archive 😋
https://github.com/zowe/imperative/blob/master/CONTRIBUTING.md#changelog-update-guidelines

@github-project-automation github-project-automation bot moved this from Low Priority to Closed in Zowe CLI Squad Oct 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev-doc documentation enhancement New feature or request priority-low Legit issue but cosmetic or nice-to-have
Projects
Status: Closed
Development

Successfully merging a pull request may close this issue.

3 participants