codebuddies / backend

CodeBuddies back-end

https://codebuddies.org

GNU General Public License v3.0

20 stars 25 forks source link

Update README with --build flag hint for whenever new packages need to be installed #194

Closed lpatmo closed 4 years ago

lpatmo commented 4 years ago

What type of PR is this? (check all applicable)

[ ] 🐛 Bug Fix
[ ] ✨ Feature (e.g. API change, enhancement, addition, etc.)
[ ] ♻️ Refactor
[x] 📝 Documentation
[ ] 🔖 Release
[ ] 🚩 Other (concerning: )

Context

I always forget that appending a --build flag is what we need to run if new packages were introduced into the code.

Added a line so it can be easily looked up in the README.

(We've talked about separating out contributing.md content from the README.md at some point, but this is not that PR.)

Other Related Tickets & Documents (as needed)

N/A

Implementation Details

Added a single line to the README.

New Libraries/Dependancies Introduced (Fill out as needed)

N/A

Any new migration files added?

[ ] 👍 yes
[x] 🙅 no, because they aren't needed

Did you add tests?

Code added or changed without test coverage or good reason for exemption won't be approved.

[ ] 👍 yes
[x] 🙋 no, because I need help
[ ] 🙅 no, because they aren't needed

Did you add documentation?

[x] 📜 readme.md
[ ] 📜 contributing.md
[ ] 📜 wiki entry
[ ] 🙋 I'd like someone to help write documentation, and will file a new issue for it
[ ] 🙅 no documentation needed

codecov[bot] commented 4 years ago

Codecov Report

:exclamation: No coverage uploaded for pull request base (main@551d43e). Click here to learn what that means. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #194   +/-   ##
=======================================
  Coverage        ?   83.78%           
=======================================
  Files           ?       32           
  Lines           ?      518           
  Branches        ?        0           
=======================================
  Hits            ?      434           
  Misses          ?       84           
  Partials        ?        0

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 551d43e...8b5f2a9. Read the comment docs.