Skip to content

Latest commit

 

History

History
136 lines (124 loc) · 6.03 KB

CONTRIBUTING.md

File metadata and controls

136 lines (124 loc) · 6.03 KB

Contributing

A large open source website is a difficult thing to manage. This document explains much of the process that we use to contribute. Thank you for your interest in contributing to Rust!

tl;dr: Always file an issue first.

Design and Content

Design and content are complicated thing, and many folks have lots of polarizing feels about it. For the moment, large design changes are made exclusively by the team (listed above). If you have concerns or thoughts for small changes, please file an issue so that we can discuss it first!

Content

The content is largely owned by the associated team or working group. If you have thoughts, it can be useful to discuss those with the lead(s) of those groups. You can learn more about the teams and working groups on the Governance page of the site.

We are currently pausing new company listings for the 'Production' page while we figure out a better process for it.

Development

Before filing a PR to the site, please file an issue. This way we can ensure that the work you are doing meets the requirements of the site and will be very likely merged. If you file a PR before an issue, you will likely be asked to file an issue, or your PR may be closed outright.

Manual testing checklist

Sometimes changes are made which could potentially affect any page, e.g. updating the templating library. In that case it's necessary to manually check (almost) every page for obvious regressions before deploying the update. To facilitate that, here's a list of links to the staging deployment. Note that like all documentation, this list may become outdated over time. So stay vigilant and update it if you notice something missing.