-
Notifications
You must be signed in to change notification settings - Fork 6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add a basic CONTRIBUTING.md #1
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
Contributing to Sky Engine | ||
========================== | ||
|
||
Getting the code | ||
---------------- | ||
|
||
To get the code: | ||
|
||
1. Fork https://github.com/domokit/sky_engine into your own GitHub account. | ||
2. [Download depot_tools](http://www.chromium.org/developers/how-tos/install-depot-tools) | ||
and make sure it is in your path. | ||
3. Create a `.gclient` file in an empty directory with the following contents: | ||
|
||
``` | ||
solutions = [ | ||
{ | ||
"managed": False, | ||
"name": "src", | ||
"url": "[email protected]:<your_name_here>/sky_engine.git", | ||
"custom_deps": {}, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is this needed? |
||
"deps_file": "DEPS", | ||
"safesync_url": "", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We can also clean this up later. |
||
}, | ||
] | ||
target_os = ["android"] | ||
``` | ||
|
||
4. `svn ls https://dart.googlecode.com/` and accept the certificate permanently. | ||
5. `gclient sync` | ||
6. `cd src` | ||
7. `git remote add upstream [email protected]:domokit/sky_engine.git` | ||
8. `./build/install-build-deps.sh` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This last step errors out on Mac. |
||
|
||
Building the code | ||
----------------- | ||
|
||
1. `./mojo/tools/mojob gn` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. should be mojob.py |
||
2. `ninja -C out/Debug` | ||
|
||
Contributing code | ||
----------------- | ||
|
||
The Sky engine repository gladly accepts contributions via GitHub pull requests. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm surprised this is even still an option.