Skip to content

Latest commit

 

History

History
93 lines (59 loc) · 4.34 KB

contributing.md

File metadata and controls

93 lines (59 loc) · 4.34 KB
Raw

Como contribuir

Se você gostou de algum dos nossos pacotes e gostaria de contribuir ou simplesmente criar um novo pacote, siga as instruções abaixo.

É altamente recomendado que tenha boas noções de git.

Instalar o Studio, um gerenciador para criar pacotes Composer

Nós recomendamos que use o pacote franzl/studio, ele facilitará a instalação dos pacotes artesãos no sua aplicação laravel ou lumen de desenvolvimento.

Apos instalar o franzl/studio e configurado ele no seu sistema para rodar a partir da linha de comando (terminal) e tendo instalado uma versão completamente nova do Laravel ou Lumen, escolha o pacote artesão que gostaria de contribuir:

Escolhido o pacote, acesse o pacote via github e faça um fork dele, pra que você tenha uma cópia do código fonte em seu repositório do github e possa fazer suas próprias modificações. E em seguida, na pasta da sua aplicação Laravel ou Lumen, faça o seguinte comando:

studio create workbench/artesaos/nome-do-pacote --git https://github.com/SEU-NICK-DO-GITHUB/nome-do-pacote

Nota: Se o pacote não for compativel com lumen, você deve saber dos riscos e deve ir adaptando-o até que funcione adequadamente.

feito isso, o studio baixará o pacote do github e suas dependencias em workbench/artesaos/nome-do-pacote e já incluirá esse pacote nos autoloads do composer da aplicação principal.

Daí em diante você deve seguir o que diz no readme.md de cada pacote para configurá-lo na sua aplicação, geralmente eles tem um ServiceProvider e um Façade que você deve configurar em config/app.php. Em outros casos também tera que publicar configurações, views, migrations e arquivos públicos, que geralmente é satisfeito com esse comando:

php artisan vendor:publish

ou

php artisan vendor:publish --provider="Artesaos\NomeDoPacote\NomeDoPacoteServiceProvider"

Dependências do pacote

Se você tiver que adicionar qualquer dependência ao pacote, ela deve ser feita no arquivo workbench/artesaos/nome-do-pacote/composer.json e então, dentro dessa pasta você deve fazer o seguinte comando no terminal:

composer update

Enviando para o servidor

Após fazer as suas modificações/contribuições para o pacote, você deve enviar o resultado para seu repositório no github, então, a partir da pasta do pacote:

git add caminho/do/arquivo/modificado
git add caminho/do/outro/arquivo/modificado
...

ou, se você sabe trabalhar com git e tem conciência dos arquivos que modificou (pode listá-los com git status), você pode adicionar todos de uma só vez:

git add --all

e então criar uma mensagem de modificação:

git commit -m "Adicionei uma nova funcionalidade muito legal"

e em seguida, enviar para seu github:

git push origin master

ou o branch que estiver trabalhando

Enviando ao Artesãos um pedido de merge

Após enviar as modificações para seu github, você deve agora enviar para o artesãos as modificações que fez, para então a equipe do artesãos resoponsável possa revisar seu código e então juntar(merge) suas modificações no repositório oficial.

Pela interface do github, vá até o projeto artesão que escolheu e na opção pull requests escolha "New pull request", certifique-se de marcar "compare across forks" e que na comparação o "artesaos/nome-do-pacote" esteja a esquerda de "SEU-NICK-GITHUB/nome-do-pacote", daí você escolhe nos dosi lados o branch que você modificou e se certifica que suas mensagens de modificação vão aparecer logo abaixo após escolher os branchs. Tudo certificado pode clicar em "create pull request" e adicionar uma mensagem a ele e uma descrição para que a equipe Artesãos possa revisar.

Participe da comunidade

Entre pra nossa comunidade Laravel Brasil no Slack e fique atualizado sobre o andamento dos pacotes, ou tire dúvidas sobre Laravel, IDEs, PHP, dentre outras.

Autor

Vagner do Carmo [email protected].