Platform Engineering Team/Event Platform Value Stream/Contribution
This page is a an RFC.
Getting Started
[edit]This page contains generale guides for contributing to projects maintained by Platform Engineering Team/Event Platform Value Stream.
TODO: link / include list of projects.
How to contact us
[edit]Our public Phabricator board can be found at https://phabricator.wikimedia.org/project/view/1474/.
WMF staff can reach the team on slack by tagging @event-plafrom in the #data-engineering channel.
Before you ask a question, it is best to search for existing tasks and documentation that might help you. In case you have found a suitable issue and still need clarification, please do reach out on slack or phabricator.
Bug reports and enhancement proposals
[edit]If you would to report a bug or propose an enhacment, we recommend the following:
- Open a task.
- Tag Event-Platform Value Stream
- Provide as much context, and examples, as you can about what you’re running into.
We will then take care of the issue as soon as possible.
Code contributions
[edit]Make sure that any code change matches the conventions and style guidelines of the project you are contributing to.
When you think the code is ready for review a pull request should be created on Gitlab (Github), or a patch should be submitted on Gerrit.
Pull requests (Github/Gitlab)
[edit]- Fork the repo you want to contribute to.
- Make sure that all tests, new and existing, pass.
- Open a MR/PR to upstream's `main`.
- Assign the MR/PR to yourself.
- Tag the project maintainers in the MR/PR body.
- Once you receive one approval you can merge the MR/PR.
Change Request (Gerrit)
[edit]- Clone repo you want to contribute to and follow the Gerrit setup practices.
- Make sure that all tests, new and existing, pass.
- Submit a patch
- Add the project maintainers as reviewers.
- Once you receive a +2 you can merge the MR/PR.
Documentation changes
[edit]If you find mistakes in our documentation, please file a bug on our phabricator board.