From 34a5ac177677fee1129b27d9fface95df8740784 Mon Sep 17 00:00:00 2001 From: Gustavo Freze de Araujo Santos Date: Mon, 26 Sep 2022 09:12:53 -0300 Subject: [PATCH] refactor: Changes documentation structure. --- .github/ISSUE_TEMPLATE/template.md | 15 +++++++++++ .gitignore | 1 + CONTRIBUTING.md | 42 ++++++++++++++++++++++++++++++ LICENSE.md => LICENSE | 2 +- README.md | 34 +++++++++--------------- 5 files changed, 72 insertions(+), 22 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/template.md create mode 100644 .gitignore create mode 100644 CONTRIBUTING.md rename LICENSE.md => LICENSE (96%) diff --git a/.github/ISSUE_TEMPLATE/template.md b/.github/ISSUE_TEMPLATE/template.md new file mode 100644 index 0000000..4cb556a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/template.md @@ -0,0 +1,15 @@ +--- +name: template +about: Siga as instruções fornecidas pelo modelo de issues. +title: 'Um título claro e descritivo para identificar o artigo' +--- + + + +## Apresentação + +Breve resumo sobre o artigo. + +## Link(s) da publicação + +Informe os link(s) de onde o artigo esta publicado. diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..723ef36 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.idea \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ee9f625 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,42 @@ +# Contribuindo + +* [Overview](#overview) +* [Como posso contribuir?](#contributing) + - [Escrevendo artigos](#writing-articles) + - [Desenvolvendo](#developing) + +
+ +## Overview + +Obrigado por investir seu tempo em contribuir para o projeto. + +Estas são as principais diretrizes, use seu bom senso e sinta-se à vontade para propor alterações a este documento em +um pull request. + +
+ +## Como posso contribuir? + +Esta seção orienta você as possíveis maneiras de contribuir. + +
+ +### Escrevendo artigos + +Depois que você tiver se artigo escrito, abra uma [issue](https://github.com/backend-br/poste-mais/issues), e preencha +os dados seguindo o modelo padrão gerado pela issue. + +- Use um título claro e descritivo para identificar o artigo. + +
+ +### Desenvolvendo + +Para iniciar o desenvolvimento, você precisará seguir alguns passos: + +- Fork este repositório. +- Faça um clone do repositório que você fez seu fork. +- Crie uma branch a partir da branch `master`. +- Adicione sua contribuição, faça o commit e push. +- Abra um [pull request](https://github.com/backend-br/poste-mais/pulls). diff --git a/LICENSE.md b/LICENSE similarity index 96% rename from LICENSE.md rename to LICENSE index 63e772b..3420e5a 100644 --- a/LICENSE.md +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2017 backend-br +Copyright (c) 2022 Back-End Brasil Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 08a8b65..91d8d7c 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,26 @@ + +

- BackEnd Brasil + BackEndBR

-## Poste Mais -Espaço destinado para divulgação de artigos nacionais relacionados ao desenvolvimento back-end com o objetivo de compartilhar conhecimento para toda a comunidade. - -Sinta-se livre para escrever a respeito de uma tecnologia que você domina e colabore com o crescimento do projeto. - -### Importante -Aconselha-se que o post seja escrito da **melhor** maneira possivel e de fácil entendimento para uma boa absorção e aprendizado, que é o nosso objetivo. +
-## Contribuindo -Abra uma **issue**, coloque o nome do TEMA entre colchetes seguido do assunto. +## Poste Mais -Exemplo: `[JavaScript] API-RESTful` +Espaço destinado para divulgação de artigos nacionais relacionados ao desenvolvimento back-end para +compartilhar conhecimento para toda a comunidade. -Informe quais _labels_ devemos adicionar, linguagem, frameworks e ferramentas. E se possivel faça uma breve descrição do artigo/post. +Sinta-se livre para escrever a respeito de uma tecnologia que você domina e colabore com o crescimento do projeto. -**Atenção**: Não aceitaremos posts fora dos padrões requisitados. +
## Licença -MIT - BackEnd Brasil [LICENSE.md](LICENSE.md) +Licenciado sob [MIT](LICENSE). -## Repositórios do Back-End Brasil +
-- [Fórum](https://github.com/backend-br/forum) -- [Eventos](https://github.com/backend-br/eventos) -- [Vagas](https://github.com/backend-br/vagas) -- [Colabore](https://github.com/backend-br/colabore) -- [Poste mais!](https://github.com/backend-br/poste-mais) -- [Awesome Back-End](https://github.com/backend-br/awesome-backend) +## Contribuindo +Siga as [diretrizes de contribuição](CONTRIBUTING.md) para contribuir com o projeto.