Developer Getting Started Guide - Apache Open Climate Workbench - Apache Software Foundation
This podling has retired. For details please refer to its
Incubator
page.
DUE TO SPAM, SIGN-UP IS DISABLED. Goto
Selfserve wiki signup
and request an account.
Apache Open Climate Workbench
Pages
Blog
Child pages
Developer Area
Developer Getting Started Guide
Browse pages
tachments (2)
Page History
Resolved comments
Page Information
View in Hierarchy
View Source
Export to PDF
Export to Word
Copy Page Tree
Jira links
Developer Getting Started Guide
Created by
Cameron Goodale
, last modified by
Ibrahim Jarif
on
Jul 29, 2016
Code Formatting and Style
Please follow the projects agreed upon code standards when making contributions. We strive to be PEP-8 compliant. You can read more about linting practices and other coding-style related topics at the
Code Style and Linting Practices
page.
Testing
We strive to ensure that the code we release on this project works as expected. When making a contribution to the project be sure to run the test suites for the relevant components before submitting your contribution. If you follow the project's dependency installation guide you will end up with
nose
installed which can make running tests easier.
Example of running OCW toolkit tests
chmod a+x test.sh
./test.sh
Creating a Pull Request on Github
Pull Requests via Github are the primary means through which contributions are made to the codebase. We maintain an identical workflow for contributors and committers alike.
Apache Climate Project on Github:
Apache Climate JIRA issue tracker:
Prerequisites to Contributing
You will need to fork the project on Github and clone it to your local machine. You will need an account of Github in order to fork the project.
Fork the project
Click the "Fork" button on the top-right side of the
project page on Github
Clone the project
Find the SSH/HTTPS clone URL on the ride side of the page on your forked version of the codebase (www.github.com/
Run the following command using the above URL in your terminal.
git clone
Step-By-Step Directions
Create/locate an issue on JIRA and save the Issue Number for later use (i.e. CLIMATE-381).
Create a Branch and name it using the JIRA Issue Number from Step 1
git checkout -b CLIMATE-381
Do your work on the branch and commit your changes. You code should be PEP-8 compliant! Please follow a
reasonable set of guidelines
when forming your commit message. The short first line summary should include the issue number from JIRA. Please be as consistent as possible with existing commit messages. For instance, we favor using a hyphen as a bullet point in our commit messages. Additionally, please write the messages in the imperative. It is recommended that you setup your editor of choice to handle this formatting for you.
CLIMATE-381 - Remove Incubator references in setup.py
- Remove '-incubating' postfix from version number.
- Remove '.incubating' from project URL.
- Update author email to point to dev@climate.apache.org
Push your branch to your repo on Github
git push origin CLIMATE-381
Log into Github and Create Pull Request via:
Be sure to include the ticket number in the title. Ex: "CLIMATE-381 - My PR Title Here" to ensure that everything mirrors correctly to JIRA.
Submitting a Patch
While not the preferred means of receiving contributions (see above), the project also accepts patches posted on a relevant ticket. The first 3 steps from above are the same here. From the branch where you made your commits you can generate a patch with the following:
git format-patch master --stdout > CLIMATE-###-
Post that output file onto the relevant ticket.
Committing to the Master
If you have commit karma on the project be sure to clone the ASF repo found here:
$ git clone https://git-wip-us.apache.org/repos/asf/climate.git
Add the project's Github mirror as an additional remote.
$ git remote add github https://github.com/apache/climate.git
When a pull request comes in a notification will be posted on the related JIRA ticket (assuming the user followed the above directions). This notification will tell you the pull request number. Fetch the pull request with:
$ git fetch github refs/pull/
Checkout the branch and validate the request (tests work, etc). Checkout
master
and merge in the changes with:
$ git merge --no-ff CLIMATE-
When adding the merge commit message be sure reference the pull request number so it is closed properly. For instance, "close #
Github's help pages
for message formatting help. Publish the changes to the ASF repo with:
$ git push origin master
No labels
1 Comment
Lewis John McGibbney
Hi Cam and Mike... thank you adding this page.
We defo need to link to this from the main site.
Permalink
May 13, 2014
Overview
Content Tools
Atlassian Confluence Open Source Project License
granted to Apache Software Foundation.
Evaluate Confluence today
Atlassian Confluence
8.5.31
Printed by Atlassian Confluence 8.5.31
Report a bug
Atlassian News
Atlassian
{"serverDuration": 110, "requestCorrelationId": "3bac261dce521121"}