Bem-vindo ao OpenBlog! Este é um projeto de código aberto onde entusiastas da escrita e desenvolvedores podem colaborar para criar e compartilhar conteúdo de alta qualidade.
O OpenBlog é um espaço para compartilhar conhecimento, ideias e histórias. Nosso objetivo é criar um ambiente onde a comunidade possa contribuir com artigos sobre uma ampla variedade de tópicos, desde tecnologia até arte, passando por ciência e muito mais.
- Publicação de artigos por membros da comunidade.
- Comentários e interações com leitores.
- Suporte para várias categorias de conteúdo.
- Gerenciamento de usuários e permissões.
Em breve...
Se você deseja contribuir para o OpenBlog, estamos felizes em tê-lo a bordo! Aqui estão as etapas para começar:
-
Crie uma Conta: Antes de começar a contribuir, crie uma conta em nossa plataforma.
-
Escolha um Tópico: Escolha um tópico ou assunto para o seu artigo. Certifique-se de que ele se encaixe em uma das categorias existentes ou proponha uma nova.
-
Escreva seu Artigo: Escreva seu artigo em formato Markdown ou HTML. Certifique-se de seguir nossas diretrizes de estilo, que podem ser encontradas no arquivo STYLE_GUIDE.md.
-
Envie seu Artigo: Faça um fork deste repositório, adicione seu artigo à pasta
/articles
e crie um Pull Request. -
Revisão e Publicação: Nossa equipe de revisores avaliará seu artigo, fornecendo feedback e sugestões. Uma vez aprovado, seu artigo será publicado no blog.
/articles
: Este diretório contém os artigos do blog./images
: Aqui você pode armazenar imagens relacionadas aos artigos./docs
: Documentação sobre o projeto.
-
Convenções de Commits
- Antes de começar, familiarize-se com as convenções de commits do OpenBlog. Siga essas diretrizes para formatar suas mensagens de commit.
- Exemplo de Mensagem de Commit:
git commit -m "feat(blog): adicionar pesquisa global"
-
Fork do Repositório
- Faça um fork do repositório OpenBlog para a sua conta no GitHub.
-
Clone o Repositório Localmente
- Clone o repositório do OpenBlog do seu fork no seu ambiente de desenvolvimento.
- Exemplo de Clonagem:
git clone https://github.com/wi2david/OpenBlog.git
-
Configurar um Ambiente de Desenvolvimento Local
- Se você deseja ajudar a desenvolver o código fonte do blog, siga estas etapas:
- Instale as dependências:
npm install
- Inicie o servidor local:
npm start
- Acesse o blog em seu navegador em
http://localhost:3000
- Instale as dependências:
- Se você deseja ajudar a desenvolver o código fonte do blog, siga estas etapas:
-
Crie uma Nova Branch
- Crie uma branch com um nome descritivo a partir da branch principal.
- Exemplo de Criação de Branch:
git checkout -b minha-contribuicao
-
Faça Suas Alterações
- Faça as alterações no código seguindo as melhores práticas.
-
Faça Commits das Alterações
- Faça commits com mensagens descritivas, seguindo as convenções de commits.
- Exemplo de Commit:
git commit -m "fix(blog): corrigir erro de renderização"
-
Envie as Alterações para Seu Fork
- Envie as alterações para sua branch no GitHub.
-
Crie um Pull Request
- No repositório principal do OpenBlog, crie um Pull Request descrevendo suas alterações.
- Exemplo de Descrição de Pull Request:
Adiciona pesquisa global ao blog. Melhora a usabilidade.
-
Aguarde a Revisão e Feedback
- A equipe de mantenedores revisará suas alterações e fornecerá feedback.
-
Aceitação e Integração
- Após revisão e aprovação, suas alterações serão integradas no repositório principal.
Obrigado por contribuir para o OpenBlog! Siga as convenções de commits para um histórico organizado. Aguardamos suas contribuições.
Este projeto é licenciado sob a Creative Commons. Consulte o arquivo LICENSE para obter mais detalhes.
Se você tiver alguma dúvida ou precisar de ajuda, entre em contato conosco em wi2david.mail@gmail.com.
Agradecemos por contribuir para o OpenBlog!