2.9 KiB
Contributing to Academic
For help, support, and questions please use our community chat 🚑.
Where to Start
Learn how to contribute code on Github.
If you're a developer looking to contribute, but you're not sure where to begin, check out the good first issue label on Github, which contains small tasks that have been specifically flagged as being friendly to new contributors.
After that, if you're looking for something a little more challenging to sink your teeth into, there's a broader help wanted label encompassing issues which need some love.
If you have a straightforward bug fix or improvement, feel free to contribute it in a Pull Request.
If you have an idea for a new feature, please start by searching the issues to check that the feature has not already been suggested and then suggest it by opening a new issue, as adding new features to Academic first requires some analysis around the design and spec.
To contribute a new language pack, refer to the language pack guide. Once created, place you language pack in academic/i18n/, add the name of the language to academic/data/i18n/language.yaml, and open a Pull Request on Github with these two files.
To contribute to Academic Admin, the automatic publication importer, refer to its dedicated Github repository.
Stickers
🖼️ Decorate your laptop or journal with an Academic sticker
Donations
As a pure community-driven open source project, we welcome your support:
Other ways to help
If you're not a developer there are still plenty of ways that you can help. We always need help with:
- Helping our Academic community on the chat
- Improving the documentation and writing tutorials
- Just click the Edit button at the bottom of pages or contribute to the documentation repository
- Testing and quality assurance
- Hosting local Academic themed events or meetups
- Promoting Academic to others by blogging, vlogging, code streaming, talking etc.