steve
/
mybuddy
mirror of https://github.com/snachodog/mybuddy.git
1
0
Fork 0
Code Issues 3 Packages Projects 1 Releases Wiki Activity

Add caveats to pull request docs

This commit is contained in:
Christopher C. Wells 2022-02-21 11:25:28 -08:00
parent 20abd11213
commit 92136569c4
1 changed files with 34 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
docs/contributing/pull-requests.md
View File

@ -5,6 +5,40 @@ and [Pull Requests](https://github.com/babybuddy/babybuddy/pulls). Maintainers
and users may also be found at [babybuddy/Lobby](https://gitter.im/babybuddy/Lobby) and users may also be found at [babybuddy/Lobby](https://gitter.im/babybuddy/Lobby)
on Gitter. on Gitter.
## Caveats
### Icon font
Baby Buddy uses [Fontello](https://fontello.com/) to build a custom icon font
for icons used throughout the application. See [`babybuddy/static_src/fontello`](https://github.com/babybuddy/babybuddy/tree/master/babybuddy/static_src/fontello)
for further documentation about using the config file with Fontello and license
information for fonts used by this application.
### Pipfile
If the [Pipfile](https://github.com/babybuddy/babybuddy/tree/master/Pipfile) is changed
the [requirements.txt](https://github.com/babybuddy/babybuddy/tree/master/requirements.txt)
must also be updated to reflect the change. This is necessary because hosting environments
do not provide adequate support for pipenv. To update the `requirements.txt` file to be in
sync with the `Pipenv` file run:
pipenv lock -r > requirements.txt
Add and commit the changes to the `requirements.txt` file.
### Static files
If static file assets (files in a `static_src` directory) are updated the production
static files (in the [`static` directory](https://github.com/babybuddy/babybuddy/tree/master/static))
must also be updated *and committed*. This is done because it prevents the need for Node
and related tooling in deployment environments. See [`gulp updatestatic`](gulp-command-reference.md#updatestatic)
for more information on how to update the static files.
### Translations
Modifying [locale files](/locale) requires some extra steps. See [Translation](translation.md)
for details.
## Pull request process ## Pull request process
1. Fork this repository and commit your changes. 1. Fork this repository and commit your changes.
@ -17,10 +51,3 @@ on Gitter.
Maintainers will review new pull requests will as soon as possible, and we will Maintainers will review new pull requests will as soon as possible, and we will
do our best to provide feedback and support potential contributors. do our best to provide feedback and support potential contributors.
## Icon Font
Baby Buddy uses [Fontello](https://fontello.com/) to build a custom icon font
for icons used throughout the application. See [`babybuddy/static_src/fontello`](/babybuddy/static_src/fontello)
for further documentation about using the config file with Fontello and license
information for fonts used by this application.