Organize project #41
Organize project #41
Conversation
| @@ -2,3 +2,113 @@ | |||
| *.pyc | |||
| local_settings.py | |||
| *.db | |||
|
|
|||
There was a problem hiding this comment.
praise: Thanks for including this. As this was a project that I used to be the only developer, this didn't bothered me much, but when we have new contributors, it is very helpful to make git easier to use.
| @@ -0,0 +1,11 @@ | |||
| run: | |||
There was a problem hiding this comment.
suggestion: I don't use this pattern too much (usually I type the entire command), but it may be useful for other developers. I will just suggest that you include a command to run the tests too.
| python dojopuzzles/manage.py migrate | ||
|
|
||
| update-static-files: | ||
| sudo rm -rf staticfiles/* && python manage.py collectstatic |
There was a problem hiding this comment.
question: Why use sudo?
suggestion: Use --clear to clear old static files that are not used anymore.
| @@ -24,3 +24,51 @@ Quero ajudar! | |||
|
|
|||
| [](https://bitdeli.com/free "Bitdeli Badge") | |||
|
|
|||
| Rodando o projeto! | |||
| ---------------------- | |||
There was a problem hiding this comment.
nitpick: Keep the - with the same size of the title. It looks better :-)
| @@ -24,3 +24,51 @@ Quero ajudar! | |||
|
|
|||
| [](https://bitdeli.com/free "Bitdeli Badge") | |||
|
|
|||
| Rodando o projeto! | |||
There was a problem hiding this comment.
nitpick: Please remove the !. Title are already highlighted.
| Rodando o projeto! | ||
| ---------------------- | ||
|
|
||
| ### Requeriments |
There was a problem hiding this comment.
nitpick: Project Requirements would be better.
| - Python 3.7 | ||
| - Django 3 | ||
|
|
||
| ### Instalando a VirtualEnv |
There was a problem hiding this comment.
suggestion: Instead of suggesting a specific tool to create a separated virtualenv, just add a suggestion that it would be a good idea to create a separated virtual environment before installing the project. I use pyenv to manage them for example.
|
|
||
| * **Renne Rocha** - *Initial work* - [rennerocha](https://github.com/rennerocha) | ||
|
|
||
| ### Apoiadores |
There was a problem hiding this comment.
suggestion: We have more contributors that these two. I would prefer to keep the names out and just add a link to https://github.com/dojopuzzles/dojopuzzles/graphs/contributors (as you did in the end of the section).
|
|
||
| * **Renne Rocha** - *Initial work* - [rennerocha](https://github.com/rennerocha) | ||
|
|
||
| ### Apoiadores |
There was a problem hiding this comment.
nitpick: Contribuidores is better
| $ make run | ||
| ``` | ||
|
|
||
| ## Criador |
There was a problem hiding this comment.
suggestion: Even that I am the creator of the project, I prefer not to have my name on this document. Just remove this section. My name will appear together with other contributors.
Organize base project with Makefile and update Readme / gitignore to run project