🇧🇷 Como contribuir
Para contribuir com este repositório, siga estas etapas:
- Crie um módulo Gradle com o nome do algoritmo.
Por exemplo, para contribuir com um algoritmo de ordenação por inserção, você criaria um módulo chamado InsertionSort
.
- Copie o arquivo
build.gradle
de outro módulo e altere os parâmetros necessários para o nome do módulo.
O arquivo build.gradle
contém as configurações do projeto, como as dependências do projeto e as informações de compilação. Você precisará alterar o nome do módulo e o nome da classe principal no arquivo build.gradle
.
- Implemente a interface
SortInterface
em sua classe com o método de ordenação.
A interface SortInterface
define o método de ordenação que todos os algoritmos de ordenação devem implementar. Você precisará implementar este método em sua classe para que o algoritmo funcione corretamente.
- Copie a classe
Main
e mude a inicialização da variávelsort
para a sua classe.
A classe Main
é responsável por executar os algoritmos de ordenação. Você precisará alterar a inicialização da variável sort
para a sua classe para que o algoritmo seja executado corretamente.
- Crie um pull request com o nome do algoritmo no título.
Depois de concluir as etapas acima, crie um pull request para enviar suas alterações para o repositório. No título do pull request, inclua o nome do algoritmo que você está contribuindo.
Recomendações
Aqui estão algumas recomendações para contribuir com este repositório:
- Use um nome de módulo significativo para o seu algoritmo. Isso ajudará os outros a encontrar seu algoritmo facilmente.
- Dê um nome à sua classe que reflita o algoritmo que ela implementa. Isso tornará mais fácil para os outros entenderem o que sua classe faz.
- Adicione comentários ao seu código para explicar o que ele faz. Isso ajudará os outros a entender seu algoritmo.
- Teste seu algoritmo para garantir que ele funcione corretamente. Você pode usar um framework de testes como o JUnit para testar seu algoritmo.
Obrigado por contribuir!
🏴 How to contribute
To contribute to this repository, follow these steps:
- Create a Gradle module named after the algorithm.
For example, to contribute a bubble sort algorithm, you would create a module named BubbleSort
.
- Copy the
build.gradle
file from another module and change the required parameters to match the module name.
The build.gradle
file contains project settings, such as project dependencies and build information. You will need to change the module name and the main class name in the build.gradle
file.
- Implement the
SortInterface
interface in your class with the sorting method.
The SortInterface
interface defines the sorting method that all sorting algorithms must implement. You will need to implement this method in your class for the algorithm to function correctly.
- Copy the
Main
class and change the initialization of thesort
variable to your class.
The Main
class is responsible for running the sorting algorithms. You will need to change the initialization of the sort
variable to your class for the algorithm to run correctly.
- Create a pull request with the algorithm name in the title.
After completing the above steps, create a pull request to submit your changes to the repository. In the pull request title, include the name of the algorithm that you are contributing.
Recommendations
Here are some recommendations for contributing to this repository:
- Use a meaningful module name for your algorithm. This will help others easily find your algorithm.
- Give your class a name that reflects the algorithm it implements. This will make it easier for others to understand what your class does.
- Add comments to your code to explain what it does. This will help others understand your algorithm.
- Test your algorithm to ensure that it functions correctly. You can use a testing framework such as JUnit to test your algorithm.
Thank you for contributing!