Hey there 👋
Are you interested to contribute to our open source project? That would be awesome, we are always looking for contributors 👍
The following guide is here to try to guide you through the process of contributing to our project in case you do not know where to get started. If you have further questions, we are happy to help, just ping us on our Slack channel.
Everyone is welcomed to contribute to our projects, no matter how experienced you are. DeckDeckGo was an important learning experience for ourselves and, we would be happy if contributing to our project is also profitable to you in terms of learning.
DeckDeckGo is a mix of applications, components, functions and infrastructure. You could have a look to our README which lists all of these.
In short summary, all our applications and components are developed with Stencil.JS Web Components.
Our website is implemented with Gatsby.
On the other side, our publication engine is developed with Haskell, Nix and Terraform.
We are flagging our issues with the labels good first issue when we think that the issue is accessible without too much experience and know-how of our project. We are also flagging issue with the label question when we need your input. It could be general questions such as brainstorming regarding UX or anything else.
You are welcomed to find these kinds of issues to get started but obviously if you don't find any issue, don't hesitate to take over other types of issues if they inspire you.
In any case, ping us to get start, your help would be super appreciated!
Some bugs (sh*t happens) might not yet been reported. Likewise, your awesome ideas to make DeckDeckGo better are always wanted. Therefore don't hesitate to open new issues but if you are unsure about if it's the right place or if you would like to discuss it first, go to Slack for that purpose.
We are in the making of adding i18n to our applications. These following are those which can be currently translated.
We would be grateful to get your help to translate our apps!
The new website of DeckDeckGo supports i18n. To provide a new language with a Pull Request, follow these steps:
- Copy each pages to their new languages. For example
index.en.jstoindex.fr.jsto create a French page. - Translate the text of the pages "index, enterprise and discover" in their related json data.
- Translate all other pages directly in their related Javascript files (we did not extract the text from the "simple" page).
- Provide a translation for the meta description.