This project is a GraphX-based open source effort. All kinds of contributions are always welcome!
The iWCT-GraphX website is constructed with MDwiki and hosted on GitHub. You can just fork iWCT-GraphX-webpage on GitHub, modify the develop branch and send a pull request. Please create an issue whenever the modification is massive. There is no need to submit a CLA.
If you are a developer, feel free to fork iWCT-GraphX-algorithm on GitHub and send in pull requests. Right now there are no strict coding guidelines, but please follow the basic Scala and C/C++ Language specifications, and annotate the Scala codes in a Scala-doc style. These can make the code more readable and help build the API docs automatically.
For code contributions, submission of a contributors license agreement is not currently required. However, the iWCT-GraphX-algorithm project is licensed GNU General Public License v2 now. Any users or developers should follow this license. The CLA might be changed later, then the contributing documentation will be updated.
As we will only keep the stable and well-tested documents and codes in the master branch, please remember to fork the develop branch instead (and send pull requests to develop too).
Note: If you are a newbie to Git, you can follow a simple Git guide including several basic git operations.
Note: Please add one of the following prefix in your commit message.
- [docs] Fix a typo in README
- [hotfix] Fix a bug
- [feature] Add a new algorithm
- [issue-1234] Fix the bug mentioned in Issue-1234
- Other reasonable prefixes
When a bug or any necessary future work is found, you can post it in Issues first and solve them in future.