Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(78)

Side by Side Diff: CONTRIBUTING.md

Issue 1451373002: Updating mozdownload (excluding tests) (Closed) Base URL: https://chromium.googlesource.com/chromium/deps/mozdownload@master
Patch Set: Updated README.md Created 5 years, 1 month ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « no previous file | History.md » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
1 ## How to contribute
2 So you want to write code and get it landed in the official mozdownload reposito ry? Then first fork [our repository](https://github.com/mozilla/mozdownload) int o your own Github account, and create a local clone of it as described in the [i nstallation instructions](https://github.com/mozilla/mozdownload#installation). The latter will be used to get new features implemented or bugs fixed. Once done and you have the code locally on the disk, you can get started. We advice to no t work directly on the master branch, but to create a separate branch for each i ssue you are working on. That way you can easily switch between different work, and you can update each one for latest changes on upstream master individually. Check also our [best practices for Git](http://ateam-bootcamp.readthedocs.org/en /latest/reference/git_github.html).
3
4 ### Writing Code
5 For writing the code just follow our [Python style guide](http://ateam-bootcamp. readthedocs.org/en/latest/reference/python-style.html), and also test with [pyla ma](https://pypi.python.org/pypi/pylama). If there is something unclear of the s tyle, just look at existing code which might help you to understand it better.
6
7 ### Submitting Patches
8 When you think the code is ready for review a pull request should be created on Github. Owners of the repository will watch out for new PR's and review them in regular intervals. By default for each change in the PR we automatically run all the tests via [Travis CI](http://travis-ci.org/). If tests are failing make sur e to address the failures immediately. Otherwise you can wait for a review. If c omments have been given in a review, they have to get integrated. For those chan ges a separate commit should be created and pushed to your remote development br anch. Don't forget to add a comment in the PR afterward, so everyone gets notifi ed by Github. Keep in mind that reviews can span multiple cycles until the owner s are happy with the new code.
9
10 ## Managing the Repository
11
12 ### Merging Pull Requests
13 Once a PR is in its final state it needs to be merged into the upstream master b ranch. For that please **DO NOT** use the Github merge button! But merge it your self on the command line. Reason is that we want to hvae a clean history. Before pushing the changes to upstream master make sure that all individual commits ha ve been squashed into a single one with a commit message ending with the issue n umber, e.g. "Fix for broken download behavior (#45)". Also check with `git log` to not push merge commits. Only merge PRs where Travis does not report any failu re!
14
15 ### Versioning
16 In irregular intervals we are releasing new versions of mozdownload. Therefore w e make use of milestones in the repository. For each implemented feature or fix the issue's milestone flag should be set to the next upcoming release. That way its easier to see what will be part of the next release.
17
18 When releasing a new version of mozdownload please ensure to also update the his tory.md file with all the landed features and bug fixes. You are advised to use the [following issue](https://github.com/mozilla/mozdownload/issues/303) as temp late for the new release issue which needs to be filed. Please also check the as sociated PR for the code changes to be made.
OLDNEW
« no previous file with comments | « no previous file | History.md » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698