Skip to content

Commit df4cd47

Browse files
niltonfredericoniltonfrederico
committed
docs: added readme, contributing, code of conduct and .github files
1 parent ea2aadc commit df4cd47

File tree

11 files changed

+817
-2
lines changed

11 files changed

+817
-2
lines changed

‎.github/CODEOWNERS‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
* @cumbucadev/cumbuca-s-core-team @cumbucadev/cumbuca-s-maintainers
2+
* @cumbucadev/nucle-documentacao

‎.github/FUNDING.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: [cumbucadev]

‎.github/dependabot.yaml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: github-actions
4+
directory: /
5+
schedule:
6+
interval: weekly
7+
time: "03:00"
8+
open-pull-requests-limit: 10

‎CODE_OF_CONDUCT.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Código de Conduta da Pessoa Colaboradora
2+
3+
[English Version](/CODE_OF_CONDUCT_EN.md)
4+
5+
Como um dos repositórios sob a organização Cumbuca Dev GitHub, este repositório segue o [Código de Conduta da Cumbuca Dev](https://github.com/cumbucadev/contributions/blob/main/CODE_OF_CONDUCT.md).

‎CODE_OF_CONDUCT_EN.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Contributor Code of Conduct
2+
3+
[Versão em Português](/CODE_OF_CONDUCT.md)
4+
5+
As one of the repositories under the Cumbuca Dev GitHub organization, this repository follows the [Cumbuca Dev Code of Conduct](https://github.com/cumbucadev/contributions/blob/main/CODE_OF_CONDUCT_EN.md).

‎CONTRIBUTING‎

Whitespace-only changes.

‎CONTRIBUTING.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Contribuindo
2+
3+
[English Version](/CONTRIBUTING_EN.md)
4+
5+
Obrigado por dedicar o seu tempo para contribuir! 🙇‍♀️🙇‍♂️ Toda ajuda é bem-vinda!

‎CONTRIBUTING_EN.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Contributing
2+
3+
[Versão em Português](/CONTRIBUTING.md)
4+
5+
Thanks for taking the time to contribute! 🙇‍♀️🙇‍♂️ Every little bit of help counts!

‎LICENSE‎

Lines changed: 674 additions & 0 deletions
Large diffs are not rendered by default.

‎README.md‎

Lines changed: 58 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,59 @@
1-
# Cumbuca Docs
1+
<div align="center">
2+
<picture>
3+
<source
4+
media="(prefers-color-scheme: dark)"
5+
srcset="https://github.com/cumbucadev/design/raw/main/images/logo-dark-transparent.png"
6+
>
7+
<img
8+
alt="Logo do Cumbuca Dev"
9+
src="https://github.com/cumbucadev/design/raw/main/images/logo-light-transparent.png"
10+
width="20%"
11+
>
12+
</picture>
13+
</div>
214

3-
https://cumbuca.dev
15+
# Comunidade
16+
17+
[English Version](/README_EN.md)
18+
19+
## 💬 Novos Funcionalidades e Reportar Bugs
20+
21+
Caso queira sugerir novas funcionalidades ou reportar bugs, basta criar
22+
uma nova [issue][github-issues] e iremos lhe responder por lá!
23+
24+
(Para saber mais sobre github issues, confira a
25+
[documentação oficial do GitHub][github-issues-doc]).
26+
27+
## 💡 Dúvidas? Ideias?
28+
29+
Dúvidas de como utilizar a biblioteca? Novas ideias para o projeto? Quer compartilhar algo com a
30+
gente? Fique à vontade para criar um tópico no nosso [Discussions][github-discussions] que iremos
31+
interagir por lá!
32+
33+
(Para saber mais sobre github discussions, confira a
34+
[documentação oficial do GitHub][github-discussions-doc]).
35+
36+
## 💻 Contribuindo com o Código do Projeto
37+
38+
Sua colaboração é sempre muito bem-vinda! Para facilitar seus primeiros passos, preparamos os seguintes arquivos:
39+
40+
- [CONTRIBUTING.md](/CONTRIBUTING.md): Aqui você encontrará todas as instruções necessárias para contribuir com o projeto.
41+
- [CONTRIBUTING_EN.md](/CONTRIBUTING_EN.md): Versão em inglês das diretrizes de contribuição.
42+
- [CODE_OF_CONDUCT.md](/CODE_OF_CONDUCT.md): Nosso código de conduta, que define as expectativas para interações respeitosas e inclusivas dentro da comunidade.
43+
- [CODE_OF_CONDUCT_EN.md](/CODE_OF_CONDUCT_EN.md): Versão em inglês do código de conduta.
44+
- [LICENSE.md](/LICENSE.md): Detalhes sobre a licença do projeto. Ela define o que você pode e não pode fazer com o código. Em geral, a licença permite que você use, modifique e distribua o código, desde que siga os termos definidos. No entanto, é importante verificar se há restrições específicas, como atribuição de crédito ao autor original ou proibição de uso comercial.
45+
46+
Certifique-se de ler esses arquivos com atenção antes de contribuir. Se tiver qualquer dificuldade ou dúvida, não hesite em nos perguntar utilizando o [GitHub Discussions][github-discussions]. Toda ajuda conta!
47+
48+
## ❤️ Quem já Contribuiu
49+
50+
<a href="https://github.com/cumbucadev/comunidade/graphs/contributors">
51+
<img src="https://contrib.rocks/image?repo=cumbucadev/comunidade" />
52+
</a></br></br>
53+
54+
_Made with [contrib.rocks](https://contrib.rocks)._
55+
56+
[github-discussions-doc]: https://docs.github.com/pt/discussions
57+
[github-discussions]: https://github.com/cumbucadev/comunidade/discussions
58+
[github-issues-doc]: https://docs.github.com/pt/issues/tracking-your-work-with-issues/creating-an-issue
59+
[github-issues]: https://github.com/cumbucadev/comunidade/issues

0 commit comments

Comments
 (0)