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

Use "Common Changelog" format for Changelog #584

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

Conversation

danielfromearth
Copy link
Collaborator

@danielfromearth danielfromearth commented May 29, 2024

Use Common Changelog.

For instance, this change recategorizes entries into "Common Changelog" groups, formats headings, and uses an imperative mood.


📚 Documentation preview 📚: https://earthaccess--584.org.readthedocs.build/en/584/

@danielfromearth danielfromearth linked an issue May 29, 2024 that may be closed by this pull request
@danielfromearth
Copy link
Collaborator Author

@jhkennedy, @mfisher87 — following up from a mention of this yesterday — any suggestions for linting of markdown in a CI pipeline?

@danielfromearth danielfromearth added the documentation Improvements or additions to documentation label May 29, 2024
@danielfromearth danielfromearth self-assigned this May 29, 2024
@mfisher87
Copy link
Member

mfisher87 commented May 29, 2024

I'm OK with bringing prettier back for formatting markdown (no strong feelings on whether we go back to using it for YAML. The new formatter we're using for YAML is more configurable). We may want to find a different mirror than the archived official pre-commit one. Several folks have already forked it (e.g. https://github.com/rbubley/mirrors-prettier) to remove the alpha/beta versions that were causing us problems.

I do feel it's important to use a formatter for accessibility. It would be nice to also add a linter, if it's compatible with our formatter, to catch only-human-fixable things like broken links, but maybe we could treat that as a separate issue.

@jhkennedy
Copy link
Collaborator

When we had looked into markdown linting before, we settled on this one as being the best option:
https://github.com/DavidAnson/markdownlint

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

Successfully merging this pull request may close these issues.

Update CHANGELOG.md to follow Common Changelog conventions
3 participants