Interested in contributing to Cboard? Thanks! There are plenty of ways you can help.
Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.
- As a developer
- As a translator
- As a manual tester
- As an automation tester
We're using Discord to collaborate, join us at: https://discord.gg/TEH8uxh
In order to contribute as a developer, you will need to have a basic understanding of React and probably Redux, you will also need to be familiar with Material-UI.
Good pull requests, such as patches, improvements, and new features, are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
Please ask first if somebody else is already working on this or the core developers think your feature is in-scope for Cboard. Generally always have a related issue with discussions for whatever you are including.
-
Clone the repo with
git clone https://github.com/cboard-org/cboard.git -
Run
yarn installin the rootcboardfolder.
Once it is done, you can modify any file locally and run yarn start, yarn test or yarn run build.
To help with translations and proofreading please use our translation management platform: https://crowdin.com/project/cboard
We currently support 40 languages, most of which were machine translated and require proofreading. Help us make Cboard available in your country!
We track all of the project issues using Github: https://github.com/cboard-org/cboard/issues
Our issue tracker is quite active, typically we got two-three bugs/week, then active tester participation is highly appreciated in order to clarify, reproduce, and track the bugs. We need help on writing a test plan! We have never written a test plan for cboard and it feels really bad. We will appreciate people that is able to design and create a comprehensive test plan covering all of the features and functions of the applications that are available in the Cboard system.
If you are proficient with automation testing, we will be happy if you can help us!. We have developed a little automation framework based on Webdriver.io, that runs using the cloud service provided by Browserstack. Here you can find the repository to start collaborating: https://github.com/cboard-org/cboard-webdriverio
We also welcome financial contributions in full transparency on our open collective. Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.
Thank you to all the people who have already contributed to cboard!
Thank you to all our backers! [Become a backer]
Thank you to all our sponsors! (please ask your company to also support this open source project by becoming a sponsor)
