We are so glad you're thinking about contributing to the project! If you're unsure about something, please don't hesitate to ask us.
- Join the chat room @ https://gitter.im/FCCVienna/ReactRoom
- Send my your username, full name or email address of your Github Account
- We will add you to the organization
- git clone the repository
- git checkout -b
- Write code
- git add . (to add all your new files)
- git commit -m "" (add a message to your commit)
- git push origin
We follow the clean architecture style and structure the codebase accordingly.
Image credit to Uncle Bob
Most important rule:
Source code dependencies can only point inwards. Nothing in an inner circle can know anything at all about something in an outer circle. In particular, the name of something declared in an outer circle must not be mentioned by the code in the an inner circle. That includes, functions, classes. variables, or any other named software entity.
Currently we use an adapted version of Gitflow. We are currently not using the develop branch as the project structure does not require it. Everything else is the same.
Image credit to nvie.com
We have created templates for issues and pull requests to ensure a coherent workflow.
As a general rule, always make sure that:
- you are formatting your code
- you are linting your code
- all tests pass
We have several integration tools hooked up for reviewing pull requests. Make sure that those tests are also passing, and if not provide a detailed explanation why not and why it is not necessary to comply.