• com essas alterações ao clicarmos para criar uma issue poderemos escolher entre:

• e você é direcionado com o template escolhido:

• alguma sugestão para colocar em algum dos templates ?
• cada template .md representa um tipo de issue da foto, podendo ser adicionado mais
• arquivo config.yaml configura que não serão aceitas issues em branco

até então:

Guia de contribuição

Trabalhar em uma Issue existente

• acesse as Issues do projeto
• atribua ela à você

Criar uma Issue para trabalhar

• você pode criar uma Issue acessando a aba de Issues
• uma Issue pode ser: bug, feature, correção, documentação, sugestão, dúvida...
• atribua ela à você

Desenvolvendo

• git clone https://github.com/Java-Dojo-Server/recipes.git
• git checkout -b feature/nome_feature
• trabalha na sua Issue e commite suas alterações
• suba sua branch para o repositório remoto
• git push origin feature/nome_feature

Abrindo um Pull Request

• vá até a página inicial do repositório
• clique em Compare & pull request
• ná página de abertura do pull request certifique que a branch target é a master
• no topo você deve selecionar base: master
• preencha os passos do template gerado e clique em Create pull request

Happy Coding!

Current readme looks like:

[]contributors-url []forks-url []stars-url []issues-url []pr-url []license-url

About The Project

(back to top)

Built With

• Java 11
• Spring

(back to top)

Prerequisites

• JDK 11
• Maven
• Docker

Running locally

Running with Docker (TODO)

1. Clone the repo

   git clone https://github.com/Java-Dojo-Server/recipes
   

2. Change directoy into project's folder

   cd recipes
   

3. Change to dev1 profile

   TODO
   

4. Run docker environment

   docker-compose up
   

Running without Docker (TODO)

1. Clone the repo

   git clone https://github.com/Java-Dojo-Server/recipes
   

2. Change directoy into project's folder

   cd recipes
   

3. Change to dev2 profile

   TODO
   

4. Run application

   mvn spring-boot:run
   

(back to top)

Usage

• register as user
• login as user
• create posts with recipes
• comment posts

For more examples, please refer to the Documentation

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

A detailed Contribution Guide can be found at CONTRIBUTING GUIDELINE

(back to top)

License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

Discord Server

This project is part of a open-source community on discord called Java Dojo. For you to contribute to this project it isn't necessary to be part of it. But in case you want, you can join by following:

Joins us - Discord Invite

(back to top)

Description

• we can run docker-compose up and the MySQL database container will spín up
• we can run the API application and it will automatically connect to the MySQL database

Blocks

• Something that you may want to ask or discuss on this PR...

Issue

• Issue you are working on in order to complete this task...

Checks

• [X] I have added descriptive commit messages
• [X] This pull request targets the master branch

• assim como o template de pull request é possível criar um template de issues
• para que ao abrir uma issue tenhamos templates para cada tipo de issue:

1. feature
2. bug report
3. suggestion

• quando uma issue for aberta, os templates serão gerados automaticamente e podendo ser escolhido como melhor servir
• dessa forma todas as issues seguirão um padrão e nos certificaremos que todas tenham a mesma qualidade

With this changes all pull requests will have the following standards:

Description

• Describe your changes...

Blocks

• Something that you may want to ask or discuss on this PR...

Issue

• Issue you are working on in order to complete this task...

Checks

• [ ] I have added descriptive commit messages
• [ ] This pull request targets the master branch

• pull request template so any pull request will have the same standard

example:

Description

Describe your changes...

Issue

Issue your work is related to...