github/Peacock
1
Fork 0
mirror of https://github.com/thepeacockproject/Peacock synced 2024-11-22 22:12:45 +01:00
Code Releases Activity

Add a proper contributing section to the readme

Browse Source
This commit is contained in:
AnthonyFuller 2023-04-16 22:32:36 +01:00
parent a1f1b1feb4
commit acd269a4ea
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
readme.md
View File

@ -45,8 +45,16 @@ just fine.
## Contributing
Writing bug reports is cool. You should do that. Or update this readme whenever
it's needed.
To contribute, you can use Pull Requests from your own fork. You can fix bugs
reported in issues or add new features you think would be useful, new features
not listed in issues would have to be discussed before merging.
To update localisation files, edit `h2_locale.json` and `h3_locale.json` in the
`resources` folder. Make sure to add the English (or translated) versions to all
languages (other than `xx`, this section can be ignored). Then make sure
`rpkg_cli.exe`, `HMLanguageTools.exe`, and `ResourceLib_*.dll` are in the
`resources` folder. Then, from the root project folder, run
`yarn rebuild-locale` and push the new RPKGs and edited locale JSON files.
Thank you to people who have contributed!