amiberry/.github/CONTRIBUTING.md
Dimitris Panokostas 40e73ea8ae
1440 create home directories on startup (#1443)
* build: move gamecontrollerdb.txt to controllers directory

* enhancement: create home directories if they don't exist

- After the directories have been decided (data, home, config), create those in the specified HOME directory, if they don't exist
- If they didn't exist, and we had the original contents installed in /usr/share/amiberry/<dir>, copy those over and change permissions. This ensures that the distributed files like the AROS ROMs, the WHDLoad booter and the controllerdb files, are always there in the home dir.

* chore: we no longer need to copy all the directories in the package

Now that we create the home directories on startup, we don't need the empty ones in the package anymore.
Only those that contain something can stay

* build: add stripping of binaries

* chore: ignore .idea folder

* bugfix: WHDLoad booter A1200 config was incorrect

After the additional entries in A1200 configs and models, the booter was set to incorrectly use a config with a Blizzard accelerator. Since that requires a board ROM, which might not be available, it has to change.

Using the default A1200 config instead, and setting Fast RAM to 8MB after that.

* build: install icon in shared location

When preparing the .deb package, the application icon should go in the /usr/share/icons/hicolor/... location, to adhere with established standards

* build: use ~/Amiberry instead of ~/.amiberry

Perhaps it's best to use a non-hidden folder for amiberry directories, make it easier on the users to find it

* refactor: use ~/Amiberry/conf instead of ~/.config/amiberry for config files

* refactor: change desktop file icon reference

Should be possible to use just "amiberry" now, that the icon file is copied in the right location

* chore: fix references to github.com/midwan -> github.com/BlitterStudio

* refactor: move plugins dir to /usr/lib/amiberry in the .deb package

If we are using a system-wide installation, with the .deb package, use /usr/lib/amiberry for plugins.
Check the HOME/Amiberry/plugins next, create it if necessary.
Fallback to the startup directory if that's not available (probably never).

* refactor: only move the abr folder in the destination plugins

When using the .deb package, only the abr folder should be copied in the destination.
Otherwise, we get a plugins directory created there as well

* refactor: Change Kickstarts to Roms

The Kickstarts directory can contain different kind of ROMs, not only kickstarts.
It's best if we rename it accordingly

* build: CPack updates

- Removed unneeded line
- added CPACK_DEBIAN_PACKAGE_ARCHITECTURE
- Added Extended Description
- Fixed description starts with package name

* ci: rename architectures properly

Let's keep the names identical to what dpkg reports

* build: fix some lintian errors

- location of plugins
- section

* build: added copyright and changelog in DEB

* build: fix location of debian files

* build: add copyright notice, fix changelog

* build: changelog should be compressed

* build: extend the description

* build: make the description lines shorter...

* build: description should not be longer than 80 chars

* build: remove timestamp from changelog

Fix another lintian complaint

* build: description again

* bugfix: the plugins dir was not correctly set

* refactor: Updated desktop entry to handle MimeTypes

* build: remove duplicate key in desktop file

* build: add more mimetypes to desktop file
2024-09-28 09:54:50 +02:00

4.9 KiB

How to contribute to Amiberry

We'd be really happy to get more people involved in the project! If you want to help, please follow these guidelines.

If you haven't already, come find us in one of these platforms:

If you found a bug

Bug reporting is an important part of making Amiberry better. If you believe you have found a bug, then please follow these steps:

  • Ensure the bug has not already been reported. Check the existing Github Issues.

  • If you're unable to find an open issue that addresses the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible and steps to recreate the problem.

  • Please use the relevant bug report template to create the issue. It was designed to help you fill in what we need, in order to locate the source of the problem and find a solution in the best way possible.

Did you write a patch that fixes a bug?

  • Open a new Github Pull Request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

  • Please use the relevant pull request template when submitting a PR.

  • Please ensure that all your commits are atomic (one feature per commit).

Do you have a request for a new feature?

  • New feature ideas are welcome, but please keep in mind they will usually take lower priority over fixing bugs. An exception to that rule might be that it's something quite easy to implement.

Do you intend to add a new feature or change an existing one?

  • Suggest your change in one of the Amiberry pages above and start writing your code.

  • Please do not open an issue on Github until you have collected positive feedback about the change. Someone else might already be working on something similar, or perhaps this change could create a problem you haven't predicted.

Did you write something that adds new features/functionality to Amiberry?

  • Open a new Github Pull Request with your changes.

  • Ensure the PR description clearly describes what your changes are designed to improve. Include the relevant issue number if applicable.

  • Please use the relevant pull request template when submitting a PR.

  • Please ensure that all your commits are atomic (one feature per commit).

Financial contributions

We also welcome financial contributions in full transparency on our open collective. Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.

Credits

Contributors

Thank you to all the people who have already contributed to Amiberry!

Backers

Thank you to all our backers! [Become a backer]

Sponsors

Thank you to all our sponsors! (please ask your company to also support this open source project by becoming a sponsor)