Skip to content

Commit

Permalink
Update CONTRIBUTING.md about committing ModCache.lua
Browse files Browse the repository at this point in the history
  • Loading branch information
Wires77 committed Sep 9, 2024
1 parent 356c29c commit 9341aa0
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Feature requests are always welcome. Note that not all requests will receive an
### When submitting a pull request:
* **Pull requests must be created against the `dev` branch**, as all changes to the code are staged there before merging to `master`.
* Make sure that the changes have been thoroughly tested!
* Make sure not to commit `./src/Data/ModCache.lua`. This is a very large, automatically generated file that is updated in the repository for releases only.
* If you're updating mod parsing logic, make sure to reload PoB with `Ctrl` + `F5` to regenerate `./src/Data/ModCache.lua`. This is a very large, automatically generated file that can be used to verify your changes didn't affect any other mods inadvertently.
* There are many more files in the `./src/Data` directory that are automatically generated. This is indicated by the header
`-- This file is automatically generated, do not edit!`. To change these, instead change the scripts in the `./src/Export` directory and rerun the exporter.
For your PR, please include all relevant changes to both the scripts and data files.
Expand Down

0 comments on commit 9341aa0

Please sign in to comment.