jaghaimo / starsector-api

Unofficial Starsector API documentation and API release.

Starsector API

Unofficial Starsector API documentation and API release.

Contributing

In order to contribute you will need a Github account.

Adding documentation via a browser (good for few files at a time):

• Find a file you want to add documentation to at https://github.com/jaghaimo/starsector-api/find/master.
• Click the pencil icon - Edit this file - to open editor.
• Add javadoc compliant documentation (https://www.oracle.com/uk/technical-resources/articles/java/javadoc-tool.html) to class, methods, properties of interest
• When done, fill out title and description and select Create a new branch for this commit and start a pull request.
• Click Propose changes and wait for review.

Adding documentation from a local repository:

• Fork this repository and clone it locally.
• Add documentation as needed.
• Push your changes to your fork.
• Create a merge request and go through review and merge process.

Once your changes have been accepted (you may be asked for edits) they will be merged to main repo and the documentation will be updated.