search

ew00github / HTTPCatClone

Recreation of http.cat
0 stars 0 forks source link

To polish off this project we should create a README #6

Closed BradRammel closed 11 months ago

BradRammel commented 11 months ago

A README is a file that should be at the base of your project and GitHub will display the contents under the repository. Here is an example repo with a README https://github.com/mgba-emu/mgba. If you scroll down past the file structure it explains things about the project. You should create a README for this project that explains what this repository does and maybe how to run the program. I think you might be storing a file with the database values locally because I struggled to get this project to run until I commented out all the configuration values in the application.properties file. If someone comes across your code it makes it much easier for them to run the project when they have this information.

Also, adding a link to the http cat website would be useful for anyone that wants to know what this project is based on

ew00github commented 11 months ago

Can I link multiple Issues to one Pull Request? I think I solved the problem with the configuration files in my Service-get()-revision branch because I think I experienced the same problem.

BradRammel commented 11 months ago

Technically you can but you'll not want to do that in a work environment. Most of the time we'd create a separate branch and PR to merge that fix into master. This keeps pull requests small and it gives the reviewers of the pull request a single thing to focus on

ew00github commented 11 months ago

That makes sense, thanks for letting me know