From 3f11523610220733ff3db64b6f90f65bfc908baa Mon Sep 17 00:00:00 2001 From: Keegan McAllister Date: Fri, 11 Oct 2013 16:46:45 -0700 Subject: [PATCH] Add CONTRIBUTING.md Fixes #1026 --- CONTRIBUTING.md | 42 ++++++++++++++++++++++++++++++++++++++++++ README.md | 3 +++ 2 files changed, 45 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000000..f38c3da8542 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,42 @@ +# Contributing to Servo + +Servo welcomes contribution from everyone. Here are the guidelines if you are +thinking of helping us: + + +## Contributions + +Contributions to Servo or its dependencies should be made in the form of GitHub +pull requests. Each pull request will be reviewed by a core contributor +(someone with permission to land patches) and either landed in the main tree or +given feedback for changes that would be required. All contributions should +follow this format, even those from core contributors. + + +## Pull Request Checklist + +- Branch from the master branch and, if needed, rebase to the current master + branch before submitting your pull request. If it doesn't merge cleanly with + master you may be asked to rebase your changes. + +- Don't put submodule updates in your pull request unless they are to landed + commits. + +- If your patch is not getting reviewed or you need a specific person to review + it, you can @-reply a reviewer asking for a review in the pull request or a + comment, or you can ask for a review in `#servo` on `irc.mozilla.org`. + +- When changing code related to the DOM, add a test to `src/test/html/content`, + either by adding it to an existing test file or creating a new one. + + +## Conduct + +We follow the [Rust Code of Conduct](https://github.com/mozilla/rust/wiki/Note-development-policy#conduct). + + +## Communication + +Servo contributors frequent the `#servo` channel on [`irc.mozilla.org`](https://wiki.mozilla.org/IRC). + +You can also join the [`dev-servo` mailing list](https://lists.mozilla.org/listinfo/dev-servo). diff --git a/README.md b/README.md index 49eaa9107c2..366835a217d 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,9 @@ The Servo Parallel Browser Project Servo is a prototype web browser engine written in the [Rust](https://github.com/mozilla/rust) language. It is currently developed on 64bit OS X and 64bit Linux. +Servo welcomes contribution from everyone. See +[`CONTRIBUTING.md`](CONTRIBUTING.md) for help getting started. + ## Prerequisites On OS X (homebrew):