Workspace guide

How to use the workspace

Tip: Remember to always follow our code of conduct, our contribution guidelines and our security policy

Tip: If you don't know what category it falls into, just use the 🪛 Update request template.

Fill in the title (don't remove the label present).
Fill in the detail fields between [].
Fill in the Assignee, Label, and Milestone corresponding to the issue's nature.
Press Create in the bottom.
Make sure a new feature is located in the 💡 New features column, updates in the 📅 To do column and bug reports in the 🕷 Bugs and issues column.

Open the workspace.
Click the title of the issue you need to update.
From here you can edit multiple things:
- To edit the title, click Edit title in the top right.
- To edit the description, click Edit in the top right corner of the description.
- To change things like labels, assignees, and milestones, use the buttons on the right side.
- To remove or archive the issue, use the button on the bottom right.

Open the workspace.
Click the title of a issue to open it. Here you can see the checklist.
Add yourself as assignee to the issue using the button on the right.
Move the issue to the 🏗 In progress column.
Work on the checklist items in your code editor. Click a checkbox to mark it done.
Once all checkmarks are done, move the issue to the 💎 Review and testing column.
Send the code to us in a ZIP folder. As GitHub sucks in micro managing changes, we will have to do it ourselves.

Open the workspace.
Click the title of a issue to open it. Here you can see the checklist.
Open the ZIP file, and review it to follow the following guides:
If the ZIP file follows all guides, and fits the code, you may merge it into the current version folder. If the code does not follow the guidelines, decline it.

Tip: Contact another team member if your unsure the code is right.

Have a folder to contain the current project (the 'shunji-railways' folder), a folder to store versions and a separate folder connected to the main branch. The project folder and launch folder need to stay separate to avoid problems overwriting, cherry picking updates and such while working on the project.

Current project folder: Download the most recent 'shunji-railways' folder from the GitHub homepage, or create a folder named as such. Place it inside the 'htdocs' folder of the XAMPP directory.
Version folder: Create any folder that is recognizable as a version folder.
GitHub launch folder: Create any folder, and clone the 'Shunji-Railways-GitHub' into the folder. You should end up with a folder named 'Shunji- Railways-GitHub' inside the launch folder, containing the '.github' files, and a 'shunji-railways' folder.

Work on the project inside the current project 'shunji-railways' folder.
If the changes are done, copy the 'shunji-railways' folder and replace the old 'shunji-railways' folder inside the GitHub launch folder. You can also replace some files, by replacing the old ones from the launch folder with the newer ones.
If its a release or a milestone, also create a new version folder inside the versions folder, and paste the files into it.
Open the GitHub launch folder in VS code, and push the new code to the GitHub website.

Make sure the launch folder contains the newest GitHub stable version, or else GitHub markdown will be lost

Open the workspace
Click on the Task view to easily move tasks between columns. Click on the Progress view to easily see and filter in what state the project is.