🎉 First off, thanks for taking the time and your effort to make Ferdium better! 🎉
- Contributing to Ferdium 6
- Table of contents
- Code of Conduct
- What should I know before I get started?
- How can I contribute?
- Setting up your development machine
- Release
This project and everyone participating in it is governed by the Ferdium Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
For the moment, Ferdium's development is only starting, aiming at releasing a 6.0.0 version with the rebranded assets and tooling upgrade completed. You can join our official Discord chat to get more updates and discuss issues with the other contributors.
As a basic rule, before filing issues, feature requests or anything else : take a look at the existing issues and check if this has not already been reported by another user. If so, engage in the already existing discussion.
Note: This list can likely get outdated. If so, please refer to the specific version of the electronuserland builder that we use in our Dockerfile.
Please make sure you are conforming to the engines requirements used by the developers/contributors as specified in the package.json and recipes/package.json files.
Currently, these are the combinations of system dependencies that work for MacOS/Linux/Windows. Versions are pinned down to the patch number so ensure you have the exact matching versions installed and in use.
# Note: 'jq' is not a required system dependency; its only here to show the combined output of versions needed
$ jq --null-input '[inputs.engines] | add' < ./package.json < ./recipes/package.json
{
"node": "16.18.0",
"npm": "8.19.2",
"pnpm": "7.14.0"
}Note: You can choose any version manager to manage multiple versions of node and npm. For eg, nvm or asdf.
The version 2.23.0 for Git is working fine for development. You can then use the console from Git to do the development procedure.
apt-get update -y && apt-get install --no-install-recommends -y rpm ruby gem && gem install fpm --no-ri --no-rdoc --no-documentdnf install libX11-devel libXext-devel libXScrnSaver-devel libxkbfile-devel rpmPlease make sure you have the following installed:
- Microsoft Visual Studio Build Tools (2019 or higher - with Windows 10 SDK selected).
git clone https://github.com/ferdium/ferdium-app.git
cd ferdium-app
git submodule update --init --recursive --remote --rebase --forceIt is important you execute the last command to get the required submodule (ferdium-recipes).
Run the following script to install all dependencies, and build Ferdium.
# On Unix
./scripts/build-unix.sh
# On Windows Powershell
.\scripts\build-windows.ps1Assets will be available in the out folder.
If you encounter the gyp: No Xcode or CLT version error on macOS at this step, please have a look here.
docker build -t ferdium-package-`uname -m` .The above will place all the built artifacts into the /ferdium folder within the image.
If you want to copy them outside of the image, simply mount a volume into a different location, and copy all files from /ferdium into the mounted folder (/ferdium-out in the example command below).
DATE=`date +"%Y-%b-%d-%H-%M"`
mkdir -p ~/Downloads/$DATE
docker run -e GIT_SHA=`git rev-parse --short HEAD` -v ~/Downloads/$DATE:/ferdium-out -it ferdium-package sh
# inside the container:
mv /ferdium/Ferdium-*.AppImage /ferdium-out/Ferdium-$GIT_SHA.AppImage
mv /ferdium/ferdium-*.tar.gz /ferdium-out/Ferdium-$GIT_SHA.tar.gz
mv /ferdium/ferdium-*.x86_64.rpm /ferdium-out/Ferdium-x86_64-$GIT_SHA.rpm
mv /ferdium/ferdium_*_amd64.deb /ferdium-out/Ferdium-amd64-$GIT_SHA.deb
mv /ferdium/ferdium-*.freebsd /ferdium-out/Ferdium-$GIT_SHA.freebsd
mv /ferdium/ferdium /ferdium-out/Ferdium-$GIT_SHA
mv /ferdium/latest-linux.yml /ferdium-out/latest-linux-$GIT_SHA.ymlRun this command on the terminal:
npm run debugNote: please prefer debug() over console.log().
However, due to an Electron bug, using require('debug') directly is dangerous and can lead to data loss in services.
Please use the src/preload-safe-debug module instead until the bug gets fixed.
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
- When only changing documentation, include
[ci skip]in the commit description
- Please use
prettierand the defined rules to maintain a consistent style
If you want to self-sign on a mac with non-registered certificate (not for distribution of the resulting package), you can follow this thread and run this command:
codesign --deep --force --verbose --sign - node_modules/electron/dist/Electron.appgit checkout nightly && git pull -r
git checkout release
git merge --no-ff nightly --no-verify
# <manually resolve conflicts>
# <manually bump version with 'beta' name (if beta) in `package.json` and `package-lock.json`>
# <create commit>
# <create tag>
git pushThis will automatically trigger the build, as part of which, a new, draft release will be created here. Once all the assets are uploaded (19 assets in total), publish the release (you will need elevated permissions in GitHub for doing this). The last commit of the release branch will be tagged.
Nightly releases are automatically triggered every day (details) and available in ferdium/ferdium. Maintainers still need to verify and manually publish the draft releases as pre-releases for now.
Since we are making a lot of changes that involve restructuring the code as well as taking a hard look at the dependencies (including node versions), please remember to update them by running the appropriate command of your chosen package manager.