Skip to content

Contributing Guidelines

Jump to bottom
Xun Li edited this page Nov 5, 2020 · 3 revisions

Note: for now, since we don't have an automation testing platform, please fork geoda repo from https://github.com/lixun910/geoda (branch v1.18), and @lixun910 will be responsible for checking the contributions before commit the contributions to official geoda repo: https://github.com/GeoDaCenter/geoda

Coding standard: even though the existing project is not strictly following, but we encourage to follow the coding standard here: https://gist.github.com/lefticus/10191322

Steps:

  1. Use Github desktop client (suggested) to fork geoda repo from https://github.com/lixun910/geoda

  2. After the fork, you will have a copy of geoda repo in your Github account, as well as a local copy on your computer. Then, in Github desktop client, please select branch "v1.18" from your geoda repo.

  3. Write your code

  4. To commit your code to your repo, go to Github desktop client, you will find your "Uncommitted Changes". Write a summary and description. Then, click "Commit to v1.18".

  5. When you are ready to push your contribution to lixun910/geoda repo, use Github desktop client, click the "Pull Request" button (top right), and write a title and description. Then click "Send pull Request" button, your contribution will be sent to lixun910/geoda, and a ticket will be created for you to track.

  6. @lixun910 will be responsible for checking the contribution before merge the pull request (contribution) to lixun910/geoda repo. Contact @lixun910 if any questions.

  7. Before an official release, @lixun910 will send a pull request with all contributions to official GeoDa repo @GeoDaCenter/geoda.

Clone this wiki locally