This repository exists because of knowledge that is shared here
Contribution notes are rules that should be respected during contributions to every project at FlowUp. These notes are mainly inspired by Angular and Golang contribution notes.
🤖 Please make sure to read the notes carefully
☀️ Last Updated: 14. June 2017
- ⚡ - important note
- 💡 - good to know
- 🪲 - possible bug alert
- github has your back in this!
Each project is divided into multiple parts - also called milestones(on github) or sprints(commonly used). Every sprint has its timespan (commonly 2 weeks) and tasks that should solved during this timespan.
Task status
💡 labels are a good way to let everybody know what is the task about
Task solving and submittion is a process that mostly relies on git-flow. This method is commonly applied to any task that is being solved. Please make sure to go through the cheatsheet.
⚡ don't solve many tasks in one feature branch. This may set the whole process on 🔥 as some tasks way rely on other and many merges could be required
⚡ always create feature branches for your tasks
Commiting changes
💡 this section is mostly taken from the Angular Contribution Notes, copied here just to make sure it won't change without us knowing
Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
The header is mandatory and the scope of the header is optional.
Type Must be one of the following:
- build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
- ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
- docs: Documentation only changes
- feat: A new feature
- fix: A bug fix
- perf: A code change that improves performance
- refactor: A code change that neither fixes a bug nor adds a feature
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- test: Adding missing tests or correcting existing tests