Skip to content
This repository was archived by the owner on Jun 15, 2026. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
74 lines (52 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

74 lines (52 loc) · 2.8 KB

How to contribute to AMF

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to AMF:

Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. If possible, use the relevant bug report templates to create the issue. If not, be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Contributing Changes

  • Read and sign the Contributors License Agreement
  • Open a new GitHub pull request with the change.
  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
  • Before submitting, please read the Code contributions section to know more about the technical contribution requirements.

Code Contributions

Development Requirements

  • Scala 2.12.15
  • sbt 1.7.3
  • Node

Version control branching

  • Always branch from master branch to ensure you are updated with the latest release.
  • Don’t submit unrelated changes in the same branch/pull request.
  • If you need to update your branch because of changes in master you should always rebase, not merge.
  • You should always be up-to-date with the latest changes in master.

Code formatting

We use Scalafmt to format our code! Please format your code before opening a Pull Request.

Running and writing tests

Important: Please include tests with any code contributions

Writing tests before the implementation is strongly encouraged.

To run tests:

$ sbt test
$ sbt cliJVM/testOnly // to run tests only for the JVM platform
$ sbt cliJS/testOnly // to run tests only for the JS platform

Code contributions must comply with a minimum of 80% coverage rate.

To run a coverage report of the whole project:

sbt coverage test coverageReport

Travis CI

Travis CI will automatically run tests upon creation of your PR, please make sure all tests pass before someone can review you contribution.

Test coverage

Contributions must comply with a minimum of 80% coverage rate.

To run a coverage report of the whole project:

sbt coverage test coverageReport

Contributors License Agreement

Please read and accept the Contributors Agreement. This should automatically create a Github issue with the record of your signature here. If for any reason, you do not see your signature there, please contact us.