Permalink
Browse files

Added guidelines on how to contribute.

  • Loading branch information...
1 parent 8b7b0f3 commit 1b30b844b3fd67e2965773c5ea74fd2e2fffdbd6 @hzr hzr committed Sep 18, 2012
Showing with 31 additions and 0 deletions.
  1. +31 −0 CONTRIBUTING.md
View
@@ -0,0 +1,31 @@
+# How to Contribute
+
+## Getting Started
+* Before starting to work on a feature, it's a good idea to file an issue in the
+ [issue tracker](https://github.com/operasoftware/dragonfly/issues) to discuss
+ the feature with the team.
+* Fork and create a branch off of 'master'.
+
+## Before Submitting
+* Make sure the code follows the [style guide](https://github.com/operasoftware/dragonfly/wiki/Code-style-guide).
@p01
p01 Sep 18, 2012

Make sure to follow the coding style guide used throughout Dragonfly.

+* Optionally install the [Dragonfly build tools](https://github.com/operasoftware/dragonfly-build-tools)
+ and run `df2 cleanrepo`. This will normalize whitespace, add BOMs to all files (needed for the build script)
+ and sort all UI strings.
+* Add tests if applicable.
@chriskr
chriskr Sep 18, 2012 Opera Software AS member

Perhaps add tests to the manual test suite (with an according link)?

+* Add your name to AUTHORS.
+
+## Submitting Changes
+Since we don't want to integrate everything directly into 'master', our workflow
@danfooo
danfooo Sep 18, 2012

Maybe make that shorter, Since we don't integrate directly into 'master', please….

@p01
p01 Sep 18, 2012

Agreed. Something like Here is the workflow to get a branch reviewed and integrated: would do.

@hzr
hzr Sep 18, 2012

I can shorten it maybe, but I think we should point out why we're requiring this instead of just normal PRs to the master branch.

@danfooo
danfooo Sep 18, 2012

It would be good to see that explained somewhere, the direct relation between branches and release paths I mean. But I think this should be linked to, rather then trying to explain in here. Not sure where it belongs either.

+for getting a branch reviewed is the following:
+* File an issue in the [issue tracker](https://github.com/operasoftware/dragonfly/issues)
+ requesting a review branch. Provide the name of your branch.
@danfooo
danfooo Sep 18, 2012

That will mostly be the issue that was opened before starting, right? Maybe it should say Add the issue where your change is discussed with the name of your branch or something like that?

+* E.g., if your branch is named 'redesigned_everything', we will create a 'redesigned_everything_reviewed'
+branch.
@danfooo
danfooo Sep 18, 2012

I wonder if contributors should create the reviewed branch themselves? Because it will have to be based on the same commit on `master? anyway, right?

@hzr
hzr Sep 18, 2012

The branch has to be created in our repository, otherwise there's no place to send the PR.

+* Send a pull request against this branch.
+* The code will be reviewed by the team.
+
+Once done, the feature will be tested. If all tests are passing, the code will be
@p01
p01 Sep 18, 2012

s/Once done, /Then

+integrated.
+
+Thanks in advance.
+

0 comments on commit 1b30b84

Please sign in to comment.