Skip to content

Commit

Permalink
refactor: Changes documentation structure.
Browse files Browse the repository at this point in the history
  • Loading branch information
gustavofreze committed Sep 26, 2022
1 parent 21744be commit 34a5ac1
Show file tree
Hide file tree
Showing 5 changed files with 72 additions and 22 deletions.
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/template.md
Original file line number Diff line number Diff line change
@@ -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'
---

<!-- Não divulgue dados pessoais aqui, pois as informações das issues são públicas. -->

## Apresentação

Breve resumo sobre o artigo.

## Link(s) da publicação

Informe os link(s) de onde o artigo esta publicado.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.idea
42 changes: 42 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Contribuindo

* [Overview](#overview)
* [Como posso contribuir?](#contributing)
- [Escrevendo artigos](#writing-articles)
- [Desenvolvendo](#developing)

<div id='overview'></div>

## 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.

<div id='contributing'></div>

## Como posso contribuir?

Esta seção orienta você as possíveis maneiras de contribuir.

<div id='writing-articles'></div>

### 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.

<div id='developing'></div>

### 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).
2 changes: 1 addition & 1 deletion LICENSE.md → LICENSE
Original file line number Diff line number Diff line change
@@ -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
Expand Down
34 changes: 13 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,26 @@
<!--suppress HtmlDeprecatedAttribute -->

<p align="center">
<img src="https://avatars3.githubusercontent.com/u/30732658?v=4&s=200" alt="BackEnd Brasil" width="230" />
<img src="https://avatars3.githubusercontent.com/u/30732658?v=4&s=200.jpg" alt="BackEndBR" width="230" />
</p>

## 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.
<div id='post'></div>

## 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.
<div id='license'></div>

## Licença

MIT - BackEnd Brasil [LICENSE.md](LICENSE.md)
Licenciado sob [MIT](LICENSE).

## Repositórios do Back-End Brasil
<div id='contributing'></div>

- [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.

0 comments on commit 34a5ac1

Please sign in to comment.