Skip to content

How to get more attention by the whole Symfony-Team to the documentation? #11762

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

Merged
merged 1 commit into from
Jun 20, 2019

Conversation

OskarStark
Copy link
Contributor

@OskarStark OskarStark commented Jun 17, 2019

We all know, documentation can make the difference for a good and a not so good framework 😄

I have an idea, I want to discuss:
GitHub already supports the CODEOWNERS file which is already used in symfony/symfony.

I propose to use it for the docs-repository, too and ask the team members if they would be willing to "take care" of their (and/or other components). In this case they would receive notification for specific ones instead of all or nothing.

This is just a starting point and we need to add more later, but first:

Thank you

@OskarStark OskarStark added this to the 3.4 milestone Jun 17, 2019
@xabbuh
Copy link
Member

xabbuh commented Jun 17, 2019

@OskarStark I like this idea. You can also add me for form and validator related files.

@OskarStark OskarStark force-pushed the codeowners-file-for-docs branch from 84634e7 to e807a28 Compare June 17, 2019 07:12
@OskarStark
Copy link
Contributor Author

@OskarStark I like this idea. You can also add me for form and validator related files.

done

@OskarStark OskarStark force-pushed the codeowners-file-for-docs branch from e807a28 to 7d975bf Compare June 17, 2019 07:13
@lyrixx
Copy link
Member

lyrixx commented Jun 17, 2019

Of course ! Thanks for the idea

Be careful, the file should be on master (this is a bit weird btw)

@OskarStark
Copy link
Contributor Author

Be careful, the file should be on master (this is a bit weird btw)

It will be upmerged to the upper branches after the merge, or what do you mean? 🤔

@lyrixx
Copy link
Member

lyrixx commented Jun 17, 2019

Oh Yes! they updated their workflow. (https://help.github.com/en/articles/about-code-owners)

During the initial release, they always took the CODEOWER file in the default branch (master), even if the PR were submitted to another branch (3.4).

This is not the case anymore, this is much better

@chalasr
Copy link
Member

chalasr commented Jun 17, 2019

👍 @OskarStark Please also add me for the console component reference + guides.

@OskarStark OskarStark force-pushed the codeowners-file-for-docs branch from 7d975bf to 73206d1 Compare June 17, 2019 08:37
@OskarStark
Copy link
Contributor Author

👍 @OskarStark Please also add me for the console component reference + guides.

Thank you, done 👍

@dunglas
Copy link
Member

dunglas commented Jun 17, 2019

Please add me too! Can we use https://github.com/symfony/symfony/blob/4.4/.github/CODEOWNERS as reference?

@OskarStark
Copy link
Contributor Author

Sure we can for the initial things, but it’s quite different and not possible to use it 1:1 overall. Let’s go step by step 😊 I will try to keep things up to date.

@javiereguiluz
Copy link
Member

Merged! Thank you Oskar.

@javiereguiluz javiereguiluz merged commit 73206d1 into symfony:3.4 Jun 20, 2019
javiereguiluz added a commit that referenced this pull request Jun 20, 2019
…he documentation? (OskarStark)

This PR was merged into the 3.4 branch.

Discussion
----------

How to get more attention by the whole Symfony-Team to the documentation?

We all know, documentation can make the difference for a good and a not so good framework 😄

I have an idea, I want to discuss:
GitHub already supports the CODEOWNERS file which is already used in `symfony/symfony`.

I propose to use it for the docs-repository, too and ask the team members if they would be willing to "take care" of their (and/or other components). In this case they would receive notification for specific ones instead of all or nothing.

This is just a starting point and we need to add more later, but first:

- [x] @lyrixx are you OK with it?
- [x] @chalasr are you OK with it?
- [x] @xabbuh are you OK with it?
- [x] @dunglas are you OK with it?

Thank you

Commits
-------

73206d1 add CODEOWNERS file for the docs
@OskarStark OskarStark deleted the codeowners-file-for-docs branch December 7, 2024 11:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants