Skip to content

Commit

Permalink
Create CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
liamlaverty committed Apr 17, 2024
1 parent 82dc555 commit b65bdeb
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .github/CONTRIBUTING
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Contributing to the Open IMO CII Calculator

Thanks for your interest in the project!

## Testing

There are some unit tests in the `EtiveMor.OpenImoCiiCalculator.Core.Tests` directory. The app uses MSTest for all unit testing.

## Submitting Changes

When making changes, please send a pull request to Open-IMO-CII-Calculator with a clear list of what changes have been made. To understand more about pull requests, please see Github's [Pull Request help page](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/getting-started/best-practices-for-pull-requests).

Pull Requests should contain one feature/change per commit (atomic commits). Pull request messages should be clear and to the point.

Please be explicit where your contribution has used generative AI &/or LLMs to create code (including tools like github copilot), and describe which model was used.

## Coding Conventions

- Prefer readability over performance
- Generally follow [dotnet coding conventions](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/coding-conventions)
- Methods and classes should be commented with `/// <summary>` style comments describing the method's purpose
- If a method implements a regulatory requirement, for example `IMO: MEPC.354(78)`, please include a reference to the exact regulation name in the comments

0 comments on commit b65bdeb

Please sign in to comment.