CONTRIBUTING.md

Contributing

Thanks for your interest in contributing to this project!

The following is a set of guidelines for contributing to this library. Most of them will make the life of the reviewer easier and therefore decrease the time required for the patch be included in the next version.

The project uses pre-commit to format code (with Spotless), validate license headers and check for secrets (with detect-secrets). To install the pre-commit hooks then first install pre-commit and then run:

pre-commit install

When you make a commit then these hooks will run and check the modified files. If it makes changes then you can review them and then git commit again to accept the changes.

Code Quality

This project uses spotless that enforces alfresco-formatter.xml to ensure code quality.

To check code-style violations you can use:

mvn spotless:check

To reformat files you can use:

mvn spotless:apply

Secret Detection

We are using detect-secrets to try to avoid accidentally publishing secret keys. If you have pre-commit installed then this should run automatically when making a commit. Usually there should be no issues, but if it finds a potential issue (e.g. a high entropy string) then you will see the following:

Detect secrets...........................................................Failed
- hook id: detect-secrets
- exit code: 1

ERROR: Potential secrets about to be committed to git repo!

Secret Type: Secret Keyword
Location:    test.txt:1

If this is a false positive and you actually want to commit the string then run these two commands:

detect-secrets scan --baseline .secrets.baseline
detect-secrets audit .secrets.baseline

This will update the baseline file to include your new code and then allow you to review the detected secret and mark it as a false positive. Once you are finished then you can add .secrets.baseline to the staged changes and you should be able to create a commit.

Because this project forms a part of Alfresco Content Services, the guidelines are hosted in the Alfresco Social Community where they can be referenced from multiple projects.

You can report an issue in the ALF project of the Alfresco issue tracker.

Read instructions for a good issue report.

Read instructions for making a contribution.

Please follow the coding standards.