@sankhyalabs/core-docs 5.7.0 → 5.8.1-dev.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +39 -33
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,56 +2,62 @@
|
|
|
2
2
|
|
|
3
3
|
# @sankhyalabs/core
|
|
4
4
|
|
|
5
|
-
### Intro
|
|
6
5
|
Esse projeto é responsavél por disponibilizar utilitários JavaScript comuns entre vários projetos.
|
|
7
6
|
|
|
8
|
-
|
|
7
|
+
## ❓ Como usar
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
Instale as dependências:
|
|
9
12
|
|
|
10
13
|
```sh
|
|
11
14
|
$ npm install @sankhyalabs/core
|
|
12
15
|
```
|
|
13
16
|
|
|
17
|
+
E utilize as funcionalidades:
|
|
18
|
+
|
|
14
19
|
```ts
|
|
15
|
-
import {
|
|
20
|
+
import {StringUtils} from '@sankhyalabs/core'
|
|
16
21
|
|
|
17
|
-
function test(){
|
|
22
|
+
function test() {
|
|
18
23
|
alert(StringUtils.isEmpty(''));
|
|
19
24
|
}
|
|
20
25
|
```
|
|
21
|
-
# Executar testes
|
|
22
|
-
```sh
|
|
23
|
-
$ npm t
|
|
24
|
-
```
|
|
25
|
-
# Como contribuir
|
|
26
|
-
- Criar uma branch com nome sugestivo para o problema/melhoria.
|
|
27
|
-
- Dentro do projeto criar uma pasta chamada "change_proposal" dentro dessa pasta deverá existir um exemplo do caso de uso/problema que você está resolvendo.
|
|
28
|
-
- Realizar as alterações.
|
|
29
|
-
- Criar caso de teste para o problema que você está resolvendo.
|
|
30
|
-
- Fazer commit na branch.
|
|
31
|
-
- Abrir MR para master, na descrição do MR, colocar a seguinte documentação :arrow_down:
|
|
32
26
|
|
|
33
|
-
|
|
34
|
-
- [ ] Hotfix
|
|
35
|
-
- [ ] Feature
|
|
36
|
-
##### Ambiente simulação:
|
|
37
|
-
- [ ] Teste/Desenvolvimento
|
|
38
|
-
- [ ] Produçãp
|
|
27
|
+
## ⁉️ Como contribuir
|
|
39
28
|
|
|
40
|
-
|
|
29
|
+
---
|
|
41
30
|
|
|
42
|
-
|
|
31
|
+
1. Crie uma branch com nome dentro
|
|
32
|
+
dos [padrões semânticos](https://comunidade.sankhya.com.br/t/sankhya-gitflow-padroes-de-nomenclatura-de-branch-para-um-fluxo-de-desenvolvimento-eficiente/7189)
|
|
33
|
+
2. Realize as alterações para resolução das suas tarefas
|
|
34
|
+
3. Se possível,
|
|
35
|
+
crie [casos de teste](https://git.sankhya.com.br/sankhyalabs/sankhyacore/-/wikis/Diretrizes-de-Codifica%C3%A7%C3%A3o#testes)
|
|
36
|
+
para a tarefa que você está executando
|
|
37
|
+
4. Faça os commits dentro
|
|
38
|
+
dos [padrões semânticos](https://comunidade.sankhya.com.br/t/formatando-mensagens-de-commit-com-cz-sankhya/7191) para
|
|
39
|
+
a sua branch
|
|
40
|
+
5. Abra um merge request para a branch alvo com as informações de acordo
|
|
43
41
|
|
|
44
|
-
|
|
42
|
+
> Por favor, siga os padrões de código descritos
|
|
43
|
+
> em [nossa Wiki](https://git.sankhya.com.br/sankhyalabs/sankhyacore/-/wikis/Diretrizes-de-Codifica%C3%A7%C3%A3o)!
|
|
45
44
|
|
|
46
|
-
|
|
47
|
-
#
|
|
48
|
-
#
|
|
49
|
-
#
|
|
45
|
+
## ⚡ Utilitários
|
|
50
46
|
|
|
51
|
-
|
|
47
|
+
---
|
|
52
48
|
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
49
|
+
Aqui estão alguns utilitários que podem ajudar a melhorar a experiência de uso do **sankhyacore**:
|
|
50
|
+
|
|
51
|
+
- Projeto [cz-sankhya](https://git.sankhya.com.br/ferramentas/devops/semantic-release/cz-sankhya) - é um adaptador que
|
|
52
|
+
extende as funcionalidades do [commitizen](https://github.com/commitizen/cz-cli), e que te ajuda a escrever mensagens
|
|
53
|
+
de commit bem formatadas e guiadas, de maneira interativa e assertiva.
|
|
54
|
+
|
|
55
|
+
#### Links comunidade Sankhya Developer 🧠
|
|
56
56
|
|
|
57
|
-
|
|
57
|
+
- [Semantic Version](https://comunidade.sankhya.com.br/t/versionamento-semantico-sem-complicacao/7184)
|
|
58
|
+
- [Padrão de nomenclatura de branches](https://comunidade.sankhya.com.br/t/sankhya-gitflow-padroes-de-nomenclatura-de-branch-para-um-fluxo-de-desenvolvimento-eficiente/7189)
|
|
59
|
+
- Fluxo de trabalho
|
|
60
|
+
- [Branch feat-dev](https://comunidade.sankhya.com.br/t/sankhya-gitflow-fluxo-de-trabalho-de-uma-branch-feat-dev/7226/1)
|
|
61
|
+
- [Branch bugfix-dev](https://comunidade.sankhya.com.br/t/sankhya-gitflow-fluxo-de-trabalho-de-uma-branch-bugfix-dev/7190)
|
|
62
|
+
- [Branch hotfix-ga](https://comunidade.sankhya.com.br/t/sankhya-gitflow-fluxo-de-trabalho-de-uma-branch-hotfix-ga/7233)
|
|
63
|
+
- [cz-sankhya](https://comunidade.sankhya.com.br/t/formatando-mensagens-de-commit-com-cz-sankhya/7191)
|