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 #54

Merged
merged 1 commit into from
Oct 25, 2022
Merged

Update CONTRIBUTING.md #54

merged 1 commit into from
Oct 25, 2022

Conversation

adrianlyjak
Copy link
Contributor

This updates contributor documentation for newly added formatCode command playframework/playframework#11513

@ihostage
Copy link
Member

CONTRIBUTING is shared for all Play Framework repositories. Only when all repositories have this alias we will be able to add this line 😄

@mkurz
Copy link
Member

mkurz commented Oct 25, 2022

@ihostage A quick grep tells me that not even all repositories have validateCode... e..g play-slick does not have it...
Of course we should add the command everywhere to make things easy, but we can also change the wording a bit like:

Usually a repository provides the sbt commands validateCode and formatCode. Run sbt validateCode to ensure all files are formatted and have the copyright header. If you changed docs please run that command inside the documentation folder as well. If validation fails, you can run the sbt formatCode command to run all of the various formatters. If the commands are not available you are welcome to open a pull request to add them.

IMHO such a wording also makes sense if we add new repositories and we don't add the commands immediately.

@felipebonezi
Copy link

Is there any list of repositories to update with validateCode?
Could we map and then work into an issue over play-meta maybe?

@mkurz
Copy link
Member

mkurz commented Oct 25, 2022

Give me a second, I grep locally and let you know

@mkurz
Copy link
Member

mkurz commented Oct 25, 2022

See playframework/play-meta#252

@adrianlyjak
Copy link
Contributor Author

CONTRIBUTING is shared for all Play Framework repositories. Only when all repositories have this alias we will be able to add this line 😄

Thanks! I was wondering about this. I like @mkurz recommendation of qualifying and moving this towards a standard.

- add formatCode command
- qualify that sbt format commands may not exist
@adrianlyjak
Copy link
Contributor Author

@ihostage @mkurz - Wording updated

@mkurz
Copy link
Member

mkurz commented Oct 25, 2022

Thanks!

@mkurz mkurz merged commit 4b24b85 into playframework:main Oct 25, 2022
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