The source code must be managed with Git.Either our internal Git-setup or on GitHub in the Acrolinx organization must be used.
KeyLemon for Mac provides an additional, functional layer of protection through facial recognition to unlock a computer. Available as a free trial version, KeyLemon for Mac provides a basic level of functioning, but additional features may be unlocked with license upgrades. Keylemon mac latest.
Acrolinx is an AI-powered platform that eliminates content chaos and delivers strategy-aligned content. The Acrolinx for Mac menu item isn't available, or can't be selected in Word, Excel, Outlook, or PowerPoint. Acrolinx for Mac.
The main development branch is
master. It's used by default for building on Jenkins.Other branches can be used for feature development. Feature branches must be merged to
master after a while.
release/<version_no>- release branches, only if you have to work on it, otherwise use tags.
master must always be clean.The source must compile and the test must pass before a commit to the master branch is allowed.If you want to share nonworking code, use another branch.
Keep the repo clean!
The repo must not contain any files created by the build process.Only add the following files to the repo if they can't be easily created:
Libraries that are distributed in a standard way like Maven Central must not be checked inbut managed with the appropriate dependency management tools (
Gradle, etc.).Be aware of files and directories like:
.project, the notorious
.DS_Store, and so on.
Never ever check in credentials or private keys.
.gitignore file to ignore all unwanted files.
Git commit messages must start with the JIRA ticket number, for example,
DEV-<XXXX>,followed by a short comment that describes what was changed.Further explanation can be added after an empty line.Usually the scope of one commit should be small enough that the title line is enough to describe it.
Formatting changes should be committed separately from code changes. Then code changes are easy to identify,and aren't hidden in noise.If you haven't pushed yet, use
git rebase to keep our history clean.Never ever rewrite public history.
We like to give customers the option to use Acrolinx in their preferred language.A native English speaker approves the English source strings,and qualified translators translate them into the four auxiliary languages (German, Swedish, French and Japanese).We have a standard L10n workflow that uses hooks to pull the latest translated strings as part of the integration build job.Create a ticket for DevOps to get the L10n workflow set up for your project.
See: Localization L10N
See the Developer Toolsarticle for an overview of the supported technologies.
The name of the job in the build system should almost be the same as the lowercase name of the packagein:
<products>-<classic?>-<os>-<platform>for the job that builds the integration, like:
word-win-x86for Word for Windows Sidebar Integration x86 version.
word-win-classic-x86for Word for Windows Classic Integration x86 version.
word-macfor Word for Mac Sidebar Integration all platforms.
vscodefor a multiplatform version of an integration for Microsoft Visual Studio Code.
word_powerpoint-winin case you have one job creating several installers for Word and for PowerPoint.
office-winin case you create a bundled package that installs multiple Microsoft Office integrations at once.
<product>-<classic?>-<platform>-deployfor the job that deploys the latest package to an update side or live system.
The project should have a short description. The description contains:
The standard build setup contains the following steps:
A typical Java project should be set up with Gradle. Maven is also ok.A provided template/parent from Acrolinx should be used.Spotless is used to ensure code quality.
A recommended toolbox is:
The project should contain configured tasks to compile, run tests,run the application (if possible) and release/deploy the artifacts.
For example in case of Grunt the following tasks should be available:
grunt dist:releaseshould compile, run tests and package a release-ready artifact of the integration.
grunt deploy:devshould deploy to an internal repo or update site.
grunt deploy:releaseshould deploy to:
Specify the version number at exactly one place in the integration code.You should do this in the standard way for the language. The minor and major version number is Acrolinx product management.If possible, use
Depending on the project,
package.json should be used.
Project settings / AssemblyInfo should be used and the information must appear in the DLL info as well.
Project settings in XCode (Info.plist)
The repo must contain a
README.md file that contains the following information:
The repo must contain a file that contains all referenced libraries and their licenses.There might be tools that provide this information based on dependency management.Make sure that you also catch dependencies of dependencies.The name of the file must be obvious, for example
LICENSES.md, or predefined by the tools that are used.