-
Notifications
You must be signed in to change notification settings - Fork 36
How Do I...?
This page is still under construction. If you have a question, ask in Discord chat!
If there's something you want to know how to do and this page doesn't help you, ask in Discord! (Also, tell us that this page doesn't address it so someone can fix that ;).)
#Questions ###Bugs
- How do I report a bug?
- How do I fix a bug?
- How do I see what bugs need to be fixed?
###New Events
- How do I get an idea for a new event?
- How do I make a new event?
- How do I find a collaborator for an event?
- How do I test an event?
- How do I add an event to the mod?
###Finding Something to Do
- How do I find something to work on?
- How do I tell people what I'm working on?
###Translation
- How do I translate this mod?
- How do I add my translation to the mod?
###GitHub
- How do I download the mod to work on?
- How do I set up a GitHub account?
- How do I set up git?
- How do I determine which branch to check out?
- How do I check out a branch?
- How do I save changes in git?
- How do I upload my work?
- How do I merge my work into
dev?
#Answers ##Bugs ###How do I report a bug? First, you will need to be logged in to your GitHub account and be marked as a collaborator on the main GitHub repository.
Go to the issues tracker and click on "New Issue" in the top right. Enter a title and a description. Click on "Label" to the right and label the issue as a bug (and optionally any other relevant labels). Optionally, click on "Milestone" to the right and indicate whether the issue needs to be fixed for the next stable release ("Next Stable"), whether it needs to be fixed for the next beta release but isn't yet in the stable code ("Next Beta"), or whether it is a long-term issue that doesn't necessarily need to be fixed before the next release ("Long Term"). Click "Submit New Issue" and you're done!
###How do I fix a bug?
First, check out the appropriate branch (probably the feature branch). Make whatever changes need to be made, and then commit them. Finally, upload your work and if it's ready to be tested then [[merge it into dev|TODO]].
###How do I see what bugs need to be fixed?
Go to the issues tracker, click on "Labels" (near the search bar), and click "bug". The only issues shown will be those labeled as bugs. Alternatively, go straight to the bug label.
##New Events
###How do I get an idea for a new event?
You can check the idea label in the issue tracker, which has many suggested ideas. You might also ask for ideas in Discord or check the forum or steam discussion threads for ideas.
###How do I make a new event?
###How do I find a collaborator for an event?
You are most likely to find a collaborator by asking in Discord! You can also add an issue to the tracker labeled with the appropriate role (i.e. "needs writer" if you want to work with a writer) and with any other appropriate labels.
###How do I test an event?
If you are not the event's coder, ask them in Discord chat how to test their event by @ messaging them (by typing @[their name]) or private messaging them. If you are the coder, the console commands event [event-id] and add_anomaly [anomaly-category] are helpful. You may need to have an object corresponding to the starting scope selected for this to work properly (i.e. you can only use add_anomaly when you have a planet selected).
###How do I add an event to the mod?