Skip to content

Commit

Permalink
docs: Create a contributing doc file
Browse files Browse the repository at this point in the history
  • Loading branch information
bush1D3v committed Jun 8, 2024
1 parent 8604991 commit 49bcd71
Showing 1 changed file with 155 additions and 0 deletions.
155 changes: 155 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
PT-BR 🇧🇷
# 🖋️ Contribuindo para o Blog

Agradeço pelo seu interesse em contribuir para o meu **Blog**. Sua ajuda é **valiosa** para melhorar e **expandir** minha aplicação. Abaixo estão as **diretrizes** e os **passos** para contribuir com meu projeto.

## 💻 Como Contribuir

### 🌳 Forkando o Repositório

Antes de começar, você **deverá** forkar o repositório do projeto para **seu perfil**.

### 🖨 Clonando seu Repositório

Após o Fork, você **precisará** clonar o repositório forkado para seu **ambiente de desenvolvimento local**:

```
git clone https://github.com/{seu-usuario}/navarro_blog_api.git
cd navarro_blog_api
```

### 🆕 Criando uma Branch

Antes de iniciar qualquer trabalho, crie uma branch separada para a sua contribuição. Use um nome descritivo para a sua branch:

```
git checkout -b feature/nova-funcionalidade
```

### 🔨 Fazendo Alterações

Faça as alterações necessárias no código, adicione novos recursos ou correções de bugs.

### 🧪 Testando

Garanta que suas alterações não quebraram nenhum recurso existente. Execute os testes e certifique-se de que todos passam:

```
make test
```

### 📝 Documentando

Mantenha a documentação atualizada. Se você adicionou novos recursos, verifique se eles estão devidamente documentados no Swagger.

### 📊 Compromissos e Push

Após concluir suas alterações e testá-las, faça um commit das alterações:

```
git add .
git commit -m <tipo de alteração>: Nova funcionalidade
```

Em seguida, envie suas alterações para o repositório:

```
git push origin feature/nova-funcionalidade
```

### 📨 Solicitando um Pull Request (PR)

Vá para o repositório no GitHub e crie um Pull Request para que sua contribuição seja revisada. Certifique-se de descrever suas alterações e fornecer informações contextuais.

### 👁 Revisão e Fusão

Após criar um Pull Request, nossa equipe revisará suas alterações e fornecerá feedback. Uma vez aprovado, suas alterações serão mescladas no projeto principal.

## 💼 Diretrizes Gerais

- Mantenha o código limpo e legível.
- Siga as boas práticas de desenvolvimento.
- Respeite as convenções de nomenclatura existentes.
- Documente adequadamente as alterações, recursos ou correções.

#

**_Agradeço pela sua contribuição e espero que possamos trabalhar juntos para tornar o meu Blog ainda melhor. Se você tiver alguma dúvida ou precisar de ajuda, não hesite em entrar em contato comigo. Juntos, podemos criar uma aplicação mais robusta e eficiente._**

ENG 🇺🇸
# 🖋️ Contributing to the Blog

Thank you for your interest in contributing to my **Blog**. Your help is **valuable** to improve and **expand** my application. Below are the **guidelines** and **steps** to contribute to my project.

## 💻 How to Contribute

### 🌳 Forking the Repository

Before you begin, you **must** fork the project repository to **your profile**.

### 🖨 Cloning your Repository

After Fork, you **will** need to clone the forked repository to your **local development environment**:

```
git clone https://github.com/{seu-usuario}/navarro_blog_api.git
cd navarro_blog_api
```

### 🆕 Creating a Branch

Before starting any work, create a separate branch for your contribution. Use a descriptive name for your branch:

```
git checkout -b feature/new-feature
```

### 🔨 Making Changes

Make necessary changes to the code, add new features or bug fixes.

### 🧪 Testing

Ensure that your changes did not break any existing features. Run the tests and make sure they all pass:

```
make test
```

### 📝 Documenting

Keep documentation up to date. If you've added new features, make sure they're properly documented in Swagger.

### 📊 Appointments and Push

After you complete your changes and test them, commit the changes:

```
git add .
git commit -m <change type>: New functionality
```

Then commit your changes to the repository:

```
git push origin feature/new-feature
```

### 📨 Requesting a Pull Request (PR)

Go to the repository on GitHub and create a Pull Request to have your contribution reviewed. Be sure to describe your changes and provide contextual information.

### 👁 Review and Merger

After creating a Pull Request, our team will review your changes and provide feedback. Once approved, your changes will be merged into the main project.

## 💼 General Guidelines

- Keep the code clean and readable.
- Follow good development practices.
- Respect existing naming conventions.
- Properly document changes, features or fixes.

#

**_Thank you for your contribution and I hope we can work together to make my Blog even better. If you have any questions or need help, don't hesitate to contact me. Together, we can create a more robust and efficient application._**

0 comments on commit 49bcd71

Please sign in to comment.