You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Obrigado por considerar contribuir para o projeto **Search Engine**! Ao seguir estas diretrizes, você estará nos ajudando a manter a qualidade do projeto e a garantir que suas contribuições sejam facilmente integradas.
6
-
7
-
## Como Contribuir
8
-
9
-
### 1. Fork do Repositório
10
-
11
-
Faça um fork do repositório principal e clone o fork em seu ambiente local:
Use uma branch separada para sua contribuição. Certifique-se de nomear a branch de acordo com a funcionalidade ou correção que está trabalhando:
20
-
21
-
```bash
22
-
git checkout -b minha-nova-funcionalidade
23
-
```
24
-
25
-
### 3. Faça Commits Claros e Significativos
26
-
27
-
Escreva mensagens de commit descritivas e curtas. Utilize o seguinte padrão de commit:
28
-
29
-
- Use o modo imperativo ("Adiciona suporte para...").
30
-
- Mantenha a primeira linha da mensagem de commit com no máximo 50 caracteres.
31
-
- Adicione uma descrição adicional após uma linha em branco, se necessário.
32
-
33
-
Exemplo de mensagem de commit:
34
-
35
-
```bash
36
-
git commit -m "Corrige bug no algoritmo PageRank"
37
-
38
-
git commit -m "Adiciona funcionalidade de busca por palavras-chave
39
-
- Implementa a função de busca no índice reverso
40
-
- Melhora a performance da indexação de grandes volumes de dados"
41
-
```
42
-
43
-
### 4. Sincronize Seu Fork Regularmente
44
-
45
-
Mantenha seu fork atualizado com as alterações do repositório principal:
46
-
47
-
```bash
48
-
git fetch upstream
49
-
git checkout main
50
-
git merge upstream/main
51
-
```
52
-
53
-
### 5. Execute os Testes
54
-
55
-
Certifique-se de que sua contribuição não quebre nada. Rode os testes unitários antes de submeter seu pull request:
56
-
57
-
```bash
58
-
make test
59
-
```
60
-
61
-
Se necessário, adicione novos testes cobrindo sua funcionalidade ou correção.
62
-
63
-
### 6. Abra um Pull Request
64
-
65
-
Depois de concluir suas alterações e testar o código, envie seu pull request:
66
-
67
-
1. Vá até a página do seu fork no GitHub.
68
-
2. Clique em "New Pull Request".
69
-
3. Preencha o título e a descrição do pull request com o máximo de detalhes sobre as alterações.
70
-
71
-
---
72
-
73
-
## Revisão de Código
74
-
75
-
Ao abrir um pull request, ele será revisado por um dos mantenedores do projeto. Tenha paciência, pois o processo de revisão pode levar algum tempo, dependendo da complexidade das alterações. Pedidos de alteração podem ser feitos durante a revisão.
76
-
77
-
## Padrões de Código
78
-
79
-
Siga estas diretrizes de estilo ao contribuir com o código:
80
-
81
-
-**Padrão C++11**: Certifique-se de que o código está compatível com o padrão C++11 ou superior.
82
-
-**Indentação**: Utilize indentação com 4 espaços, sem tabulações.
83
-
-**Nomenclatura**: Use nomes de variáveis e funções claros e significativos. Utilize `CamelCase` para classes e `snake_case` para variáveis e funções.
84
-
-**Documentação**: Escreva comentários explicativos para funções complexas ou código não trivial.
85
-
86
-
---
87
-
88
-
## Reportando Bugs
89
-
90
-
Se encontrar um bug, por favor, abra um **issue** no GitHub com as seguintes informações:
91
-
92
-
1. Descrição do bug.
93
-
2. Passos para reproduzir o bug.
94
-
3. Qual o comportamento esperado.
95
-
4. Informações sobre o ambiente (sistema operacional, versão do compilador, etc.).
96
-
97
-
---
98
-
99
-
## Agradecimentos
100
-
101
-
Agradecemos por dedicar seu tempo e esforço para melhorar o **Search Engine**. Sua contribuição é muito valiosa para nós!
3
+
Thank you for your interest in contributing to this project! Your support and collaboration are greatly appreciated. Please read these guidelines carefully to help us maintain a positive and productive community.
102
4
103
5
---
104
6
105
-
# English Version
106
-
107
-
Thank you for considering contributing to the **Search Engine** project! By following these guidelines, you will help maintain the project's quality and ensure that your contributions can be easily integrated.
Create a separate branch for your contribution. Make sure to name the branch according to the feature or bug fix you are working on:
19
+
Create a separate branch for your contribution. Make sure to name the branch according to the feature or bug fix you are working on. Each pull request **must** be associated with its own branch. GitHub provides an option to directly create branches linked to issues, which can simplify this process:
122
20
123
21
```bash
124
22
git checkout -b my-new-feature
125
23
```
126
24
127
-
### 3. Make Clear and Meaningful Commits
25
+
### 3. Open an Issue or Discussion Before Implementation
26
+
27
+
Before starting work on a feature or bug fix, create an **issue** or open a **discussion** in the repository. This allows maintainers and contributors to provide feedback, avoid duplicated efforts, and ensure that the planned implementation aligns with the project's goals.
28
+
29
+
### 4. Make Clear and Meaningful Commits
128
30
129
31
Write descriptive and concise commit messages. Follow this commit message convention:
130
32
131
-
- Use the imperative mood ("Add support for...").
33
+
- Use the imperative mood (e.g., "Add support for...").
132
34
- Keep the first line of the commit message under 50 characters.
133
35
- Add a longer description after a blank line, if needed.
- Improve indexing performance for large data sets"
143
45
```
144
46
145
-
### 4. Keep Your Fork Synchronized
47
+
### 5. Keep Your Fork Synchronized
146
48
147
49
Regularly update your fork with changes from the main repository:
148
50
@@ -152,7 +54,7 @@ git checkout main
152
54
git merge upstream/main
153
55
```
154
56
155
-
### 5. Run Tests
57
+
### 6. Run Tests
156
58
157
59
Ensure that your contribution does not break anything. Run the unit tests before submitting your pull request:
158
60
@@ -162,7 +64,7 @@ make test
162
64
163
65
If necessary, add new tests covering your functionality or fix.
164
66
165
-
### 6. Submit a Pull Request
67
+
### 7. Submit a Pull Request
166
68
167
69
After completing your changes and testing the code, submit your pull request:
168
70
@@ -176,6 +78,8 @@ After completing your changes and testing the code, submit your pull request:
176
78
177
79
When you open a pull request, it will be reviewed by one of the project maintainers. Please be patient, as the review process may take some time depending on the complexity of the changes. Reviewers may request changes during the process.
178
80
81
+
---
82
+
179
83
## Coding Standards
180
84
181
85
Follow these coding guidelines when contributing:
@@ -198,6 +102,25 @@ If you find a bug, please open an **issue** on GitHub with the following informa
198
102
199
103
---
200
104
105
+
## Links to Documentation
106
+
107
+
For more details on how to contribute, please refer to the following:
108
+
-[GitHub Documentation on Forking Repositories](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
1.**Respect others**: Treat all contributors and users with respect. Harassment, trolling, or abusive language will not be tolerated. Please refer to our [Code of Conduct](CODE_OF_CONDUCT.md) for more details.
119
+
2.**Be constructive**: Provide helpful feedback, avoid unproductive criticism, and aim to make this project better for everyone.
120
+
3.**Collaborate**: Communicate openly and proactively to ensure smooth teamwork and avoid duplicated efforts.
121
+
122
+
---
123
+
201
124
## Acknowledgements
202
125
203
126
Thank you for taking the time to contribute to the **Search Engine** project. Your contribution is greatly appreciated!
0 commit comments