Contributing

General

Obtaining Access

For members of Robotics @APEX, request access to the Robotics @APEX GitHub organisation, roboapex or inform an ExCo. Submissions of pull requests, issues or discussion threads in the roboapex.github.io GitHub repository are also welcomed.

info

Please be respectful in all contributions.

Articles

Installation and Setup

1. Install GitHub Desktop.app or git.
2. Install node.
3. Open GitHub Desktop.app and clone roboapex/roboapex.github.io. Alternatively, clone it from GitHub or enter the following command in Terminal.app (requires git).

   git clone https://github.com/roboapex/roboapex.github.io.git
4. Run the web application with the following command. A page at localhost should open.

   npm i
   npm run start
5. Open up the /docs directory.
6. Start editing and contributing! (Note: changes are subject to PR approvals)