Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_template_en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Issue Title

## Description

Please provide a clear and concise description of the issue.

## Steps to Reproduce (for bugs)

1. [ ] Step 1
2. [ ] Step 2
3. [ ] Step 3

## Expected Behavior

Describe what you expected to happen.

## Actual Behavior

Describe what actually happened.

## Additional Context

Add any other relevant information or screenshots about the issue.

## Environment Details

- **Operating System**: (e.g., Ubuntu 20.04, macOS 13.0)
- **Rust Version**: (e.g., rustc 1.72.0)
- **Cargo Version**: (e.g., cargo 1.72.0)

Thank you for helping us improve the project!
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/issue_template_pt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Título da Issue

## Descrição

Por favor, forneça uma descrição clara e concisa do problema.

## Passos para Reproduzir (para bugs)

1. [ ] Passo 1
2. [ ] Passo 2
3. [ ] Passo 3

## Comportamento Esperado

Descreva o que você esperava que acontecesse.

## Comportamento Real

Descreva o que realmente aconteceu.

## Contexto Adicional

Adicione qualquer outra informação relevante ou capturas de tela sobre o problema.

## Detalhes do Ambiente

- **Sistema Operacional**: (ex: Ubuntu 20.04, macOS 13.0)
- **Versão do Rust**: (ex: rustc 1.72.0)
- **Versão do Cargo**: (ex: cargo 1.72.0)

Obrigado por nos ajudar a melhorar o projeto!
16 changes: 16 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template_en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Pull Request Title

## Description

Please include a summary of the changes and the related issue (if applicable).

## Checklist

- [ ] I have run `cargo fmt` to format the code.
- [ ] I have run `cargo test` and verified that all tests pass.
- [ ] I have added tests for the changes, if applicable.
- [ ] I have updated documentation, if applicable.

## Verifying Conflicts with Main

For detailed instructions, see [GitHub's guide on resolving merge conflicts](https://docs.github.com/en/get-started/using-git/resolving-merge-conflicts).
16 changes: 16 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template_pt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Título do Pull Request

## Descrição

Inclua um breve resumo das alterações e o problema relacionado (se aplicável).

## Lista de Verificação

- [ ] Executei o comando `cargo fmt` para formatar o código.
- [ ] Executei `cargo test` e verifiquei que todos os testes passaram.
- [ ] Adicionei testes para as alterações, se aplicável.
- [ ] Atualizei a documentação, se aplicável.

## Verificando Conflitos com a Main

Para instruções detalhadas, veja o [guia do GitHub sobre resolução de conflitos de mesclagem](https://docs.github.com/pt/get-started/using-git/resolving-merge-conflicts).
61 changes: 61 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Contributing to the Project

Thank you for considering contributing to this project! We welcome contributions from everyone. Please follow the guidelines below to help make the process smoother.

## How to Contribute

1. **Fork the repository**: Create your own copy of the repository by forking it to your GitHub account.
2. **Clone your fork**: Clone the forked repository to your local machine.
```bash
git clone https://github.com/your-username/project-name.git
```
3. Create a branch: Create a new branch for your feature or bugfix.
```bash
git checkout -b feature/your-feature
```
4. Make your changes: Work on your changes, ensuring that they are in line with the project's coding style.

5. Add the changed files: Before committing, add the files you changed or created using:
```bash
git add <file-name>
```
Or to add all files:
```bash
git add .
```
6. Run tests: Before submitting your pull request, ensure all tests pass.
```bash
cargo test
```
7. Commit your changes: Commit your changes with a meaningful message.
```bash
git commit -m "Describe your changes"
```
8. Push your changes: Push your branch to your fork on GitHub.
```bash
git push origin feature/your-feature
```

## Opening a Pull Request

- **Ensure your branch is up to date with `main`**: Before opening a pull request, make sure your branch has no conflicts with `main`. You can do this by updating your branch with the latest changes from `main`.
- **Create a Pull Request**: After pushing your branch to your fork, open a pull request (PR) from your branch to the `main` branch of the original repository.
- **Review and Feedback**: Once your PR is submitted, the team will review your changes. You may be asked to make some improvements or fix issues before it is merged.

### Best Practices for Opening a Pull Request

- Always provide a clear and concise description of what the PR addresses.
- Make sure your code follows the project's style guidelines.
- Ensure the code is well-tested and all tests pass.
- Use meaningful commit messages that describe the changes being made.

### Running `cargo fmt` and `cargo test`

Before submitting a pull request, please make sure to run `cargo fmt` to format the code and `cargo test` to ensure that all tests pass.

```bash
cargo fmt
cargo test
```

Thank you for helping us improve the project!
Loading