Skip to content

Commit 36d2ab3

Browse files
jboixdefagos
authored andcommitted
docs: clarify contribution scope and shared ownership
Updated both the README and CONTRIBUTING.md to explain that the Pillarbox web suite is a shared effort with no single team ownership. Clarified that the repository is focused on video.js/Pillarbox components only.
1 parent 6db3fc5 commit 36d2ab3

File tree

2 files changed

+30
-14
lines changed

2 files changed

+30
-14
lines changed

docs/CONTRIBUTING.md

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,18 @@ contribute.
88

99
## Purpose
1010

11-
Our development team is small, our ability to quickly evaluate a need or a code submission is
12-
therefore critical. Please follow the present contributing guidelines so that we can efficiently
13-
consider your proposal. You should also read or our [code of conduct](CODE_OF_CONDUCT.md), providing
11+
We aim to evaluate needs and code submissions as efficiently as possible. Since the Pillarbox web
12+
suite is a collaborative effort across multiple contributors and teams, following these contribution
13+
guidelines helps us streamline reviews and maintain consistency.
14+
15+
You should also read or our [code of conduct](CODE_OF_CONDUCT.md), providing
1416
a few guidelines to keep interactions as respectful as possible.
1517

18+
## Scope and Ownership
19+
20+
The Pillarbox web suite is a collaborative effort involving multiple teams. No single team owns the
21+
entire suite, and contributions come from various stakeholders.
22+
1623
## Contributions we are looking for
1724

1825
Any kind of contribution is welcome, as long as it improves the overall quality of our product, for
@@ -24,15 +31,19 @@ example:
2431
* Translation improvements.
2532

2633
Contributions can either take the form of simple issues where you describe the problem you face or
27-
what you would like to see in our products. If you feel up to the challenge, you can even submit
28-
code in the form of pull requests which our team will review.
34+
what you would like to see in our products. If you feel up to the challenge, you can submit code via
35+
pull requests, which will be reviewed by the Pillarbox team and other maintainers involved in this
36+
shared effort.
2937

3038
## Contributions we are not looking for
3139

3240
Requests which are too vague or not related to our product will not be taken into account. We also
3341
have no editorial influence, any issue related to the content available on our platform will simply
3442
be closed.
3543

44+
This repository focuses specifically on components related to video.js and Pillarbox only.
45+
Contributions unrelated to these components or outside this scope are unlikely to be accepted.
46+
3647
## Making a contribution
3748

3849
You can use issues to report bugs, submit ideas or request features. People with a programming
@@ -55,12 +66,14 @@ Templates are available when you want to contribute:
5566

5667
## Code conventions
5768

58-
We currently have no formal code conventions, but we try to keep our codebase consistent. In
59-
general, having a look at the code itself should be enough for you to discover how you should write
60-
your changes.
69+
While there are no formal, rigid code conventions in place, we strive to maintain a consistent
70+
codebase across all contributors and teams involved in the Pillarbox web suite. Please follow the
71+
existing style and patterns you observe in the code to ensure your changes integrate smoothly with
72+
the shared components.
6173

6274
## Code review
6375

64-
Pull requests, once complete, can be submitted for review by our team. Depending on the complexity
65-
of the involved changes, a few iterations might be needed. Once a pull request has been approved, it
66-
will be rebased, merged back into the development trunk and delivered with the next release.
76+
Pull requests will be reviewed by members of the Pillarbox team and other contributors involved in
77+
maintaining the shared components. Depending on the complexity of the changes, multiple review
78+
cycles may be needed to ensure quality and compatibility. Approved pull requests will be rebased and
79+
merged into the main development branch and included in the next release.

docs/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,12 @@ and testing the element.
7070

7171
## Contributing
7272

73-
Contributions are welcome! If you'd like to contribute, please follow the project's code style and
74-
linting rules. Here are some commands to help you get started:
73+
Contributions are welcome! The Pillarbox web suite is a common effort maintained collaboratively —
74+
no single team owns the entire suite. This repository focuses exclusively on components
75+
related to video.js and Pillarbox.
76+
77+
If you'd like to contribute, please follow the project's code style and linting rules. Here are some
78+
commands to help you get started:
7579

7680
Check your JavaScript code:
7781

@@ -112,5 +116,4 @@ Refer to our [Contribution Guide](CONTRIBUTING.md) for more detailed information
112116
This project is licensed under the MIT License. See the [LICENSE](../LICENSE) file for more details.
113117

114118
[token-settings]: https://github.com/settings/tokens
115-
116119
[token-guide]: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-with-a-personal-access-token

0 commit comments

Comments
 (0)