An open API service indexing awesome lists of open source software.

https://github.com/equinor/oilmod1-code-style

Code style configs, tools and guides.
https://github.com/equinor/oilmod1-code-style

documentation oilmod1

Last synced: 3 months ago
JSON representation

Code style configs, tools and guides.

Awesome Lists containing this project

README

          

# OILMOD1 - Code style

[![SCM Compliance](https://scm-compliance-api.radix.equinor.com/repos/equinor/a30af2d6-ea0e-468c-a8d6-1e4ebbd30d00/badge)](https://developer.equinor.com/governance/scm-policy/)

## What is the purpose of this repository?

This repository contains helpers configuration files and instructions for different IDEs.

Those should be used to configure developer IDEs with a correct code style.

## License

Files under the directory `java/intellij` are licensed under the Apache License, Version 2.0, see the `LICENSE` file for details.

The file `java/checkstyle-oilmod-checkstyle.xml` is a modification of [checkstyle's](https://github.com/checkstyle/checkstyle) [google style guide](https://github.com/checkstyle/checkstyle/blob/master/src/main/resources/google_checks.xml), and is licensed under the GNU LESSER GENERAL PUBLIC LICENSE, see the `LICENSE-checkstyle` file for details.

## Contributing

Contributions are greatly appreciated!

Please follow contribution guide available in this repository.

## Useful links

Here are some useful links to have clean and easy to maintain codebase:

- [Equinor's guideline to healthy repo](https://github.com/equinor/it-professional-network/blob/master/onboarding/healthy_repo_guideline.md)
- [Chris Beams' - How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/)