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

Add markdown checks (and fix some markdown issues) #6524

Merged
merged 13 commits into from
May 27, 2020
Merged

Add markdown checks (and fix some markdown issues) #6524

merged 13 commits into from
May 27, 2020

Conversation

koppor
Copy link
Member

@koppor koppor commented May 25, 2020

We have Markdown files, where linting issues and wrong links could be contained. This PR adds a check for it. And also fixes issues of it.

  • Change in CHANGELOG.md described (if applicable)
  • Tests created for changes (if applicable)
  • Manually tested changed features in running JabRef (always required)
  • Screenshots added in PR description (for UI changes)
  • Checked documentation: Is the information available and up to date? If not created an issue at https://github.com/JabRef/user-documentation/issues or, even better, submitted a pull request to the documentation repository.

@Siedlerchr
Copy link
Member

Siedlerchr commented May 25, 2020

Is it possible to auto-fix or auto format those files after an edit? (especially when using github for editing)

@koppor
Copy link
Member Author

koppor commented May 25, 2020

Should we really automatically add a new commit to PRs? -- Fixing some linting issues is possible. Fixing broken links not.

I would not do that, because it's uncommon (isn't it?).

Similar discussion for checkstyle versus Refaster

.github/workflows/tests.yml Outdated Show resolved Hide resolved
@koppor
Copy link
Member Author

koppor commented May 27, 2020

Removed the link check. Will add it in a follow-up PR. Everything else is working now. Had to fix some more linting issues.

@koppor koppor marked this pull request as ready for review May 27, 2020 22:36
@koppor koppor merged commit c119ca2 into master May 27, 2020
@koppor koppor deleted the add-lint branch May 27, 2020 22:40
@koppor koppor mentioned this pull request May 27, 2020
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.

3 participants