Contributing - nesbox/TIC-80 GitHub Wiki
This page is intended to provide many ideas for possible contributions to the TIC-80 project, whatever the time or the level of expertise you have.
π: little to no prior knowledge.
π: little time investment.
Content Curation
This part is accessible to everyone, requires no investment and is already very useful since it is most often lacking.
π π Test and like carts on the official website to showcase the ones that will appeal most to the community. A cart needs two likes to appear on the home page.
π π When you encounter a problem and you notice there already is an open issue about it, always like the issue!
π π Read other issues and like the issues you feel are most important to the community or easiest to fix. That will help other contributors prioritize.
You can start with:
- the issues reporting a bug, with the "bug" label.
- the issues on a specific part of the project you think needs improvement, for example the code editor.
- the issues that already have at least one like (Issues β Sort β :+1: or :heart:).
- the issues that are on the TODO list of the latest project. Some can be pushed back with release.
Restrain from liking complex features that would make the project more difficult to maintain.
Report Issues
Report a bug or request a new feature on our issues page.
π π If you don't need the Pro version, you can work with the nightly builds in order to spot bugs before the next release. Update with the latest build from time to time.
π Using the nightly builds you can also actively test the latest modifications of the code, looking for bugs.
Contribute to the Wiki
Review or improve our wiki.
Here are suggestions on how to find what to improve:
- Check that the additions of the latest release have been implemented to the wiki.
- Improve the Beginner's Tips page, especially if you are new to TIC-80.
- π When you struggle understanding something on the wiki, others will struggle too: Open an issue to ask for clarifications/improvement of the wiki page, explain what is not clear to you.
- Take a look at questions from the community on discord, telegram or elsewhere and improve the wiki to have them answered.
- Improve the Music Editor documentation to answer these questions.
- Write a tutorial, adapt a Lua tutorial to Python (or any other language you like) or π add a tutorial you've found. In particular, you can add non-English tutorials if you speak other languages.
- Add your code snippets.
- π Not all contributors of the wiki are fluent in English, do not hesitate to rephrase or correct something.
NOTE: To search for something on the wiki you need to select the "Wikis" filter of the github search bar. That way you can make sure you haven't missed anything.
More you contribute to the wiki, more ideas you will have to improve it.
Help Others
Help others with their code or questions about the project.
You will find active communities on the discord and telegram.
π The itch.io community and github discussions are not so active, questions are rarer but can remain unanswered. You can subscribe to notifications there to prevent this.
For the github discussions the subscription to notification is on the github main page β watch β custom β discussion.
Recurrent questions can suggest that the wiki needs clarification on this topic.
Contribute to the Code
If you have the capabilities to contribute to the code, your help is precious!
Create pull requests with the changes you want to make.
If you want ideas of what contributions to add, you can:
- look at the issues that are on the TODO list of the latest project.
- look at the issues labelled with "bug".
- sort the issues by number of likes to find out what the community is expecting the most.
- the code editor still needs improvements, look at the related issues.
Support the Developer
You can also consider supporting the developer by buying the PRO version or by becoming a sponsor.