Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flowup/knowledge
https://github.com/flowup/knowledge
angular best-practices go golang know-how knowledge wiki
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/flowup/knowledge
- Owner: flowup
- Created: 2016-01-19T22:32:46.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-08-02T13:31:46.000Z (over 2 years ago)
- Last Synced: 2024-05-03T03:57:37.883Z (6 months ago)
- Topics: angular, best-practices, go, golang, know-how, knowledge, wiki
- Language: TypeScript
- Size: 17.6 MB
- Stars: 22
- Watchers: 11
- Forks: 0
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Knowledge
This repository exists because of knowledge that is shared **[here](https://github.com/flowup/knowledge/wiki)**
[](https://github.com/flowup/knowledge/wiki)
-----
## Contribution Notes
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.
> :robot: Please make sure to read the notes carefully
> :sunny: Last Updated: 14. June 2017
### Note organization
- :zap: - important note
- :bulb: - good to know
- :beetle: - possible bug alert
- :octocat: - github has your back in this!
### Task Management
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.
> :octocat: github supports filtering based on labels and milestones. This makes it perfect if you want to stay on the same platform
**Task status**
> :bulb: labels are a good way to let everybody know what is the task about
### Task Solving and Submittion
Task solving and submittion is a process that mostly relies on [git-flow](https://danielkummer.github.io/git-flow-cheatsheet/). This method is commonly applied to any task that is being solved. Please make sure to go through the cheatsheet.
> :zap: don't solve many tasks in one feature branch. This may set the whole process on :fire: as some tasks way rely on other and many merges could be required
> :zap: always create feature branches for your tasks
**Commiting changes**
> :bulb: this section is mostly taken from the [Angular Contribution Notes](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines), 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:
```
():
```
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