| # Contributing to Open Financial LLMs Leaderboard | |
| Open Financial LLMs Leaderboard is [Apache 2.0 licensed](LICENSE) and accepts contributions via git pull requests. Each commit must include a DCO line in the git commit message: | |
| `Signed-off-by: GitHub User Name <[email protected]>` | |
| This sign-off means you agree the commit satisfies the | |
| [Developer Certificate of Origin (DCO).](https://developercertificate.org/) | |
| ## Contributing Issues | |
| ### Prerequisites | |
| * [ ] Have you [searched for duplicates](https://github.com/finos-labs/open-financial-llms-leaderboard/issues?utf8=%E2%9C%93&q=)? A simple search for exception error messages or a summary of the unexpected behaviour should suffice. | |
| * [ ] Are you running the latest version? | |
| * [ ] Are you sure this is a bug or missing capability? | |
| ### Raising an Issue | |
| * Create your issue [here](https://github.com/finos-labs/open-financial-llms-leaderboard/issues/new). | |
| * New issues contain two templates in the description: bug report and enhancement request. Please pick the most appropriate for your issue, **then delete the other**. | |
| * Please also tag the new issue with either "Bug" or "Enhancement". | |
| * Please use [Markdown formatting](https://help.github.com/categories/writing-on-github/) | |
| liberally to assist in readability. | |
| * [Code fences](https://help.github.com/articles/creating-and-highlighting-code-blocks/) for exception stack traces and log entries, for example, massively improve readability. | |
| ## Contributing Pull Requests (Code & Docs) | |
| To make review of PRs easier, please: | |
| * Please make sure your PRs will merge cleanly - PRs that don't are unlikely to be accepted. | |
| * For code contributions, follow the existing code layout. | |
| * For documentation contributions, follow the general structure, language, and tone of the [existing docs](https://github.com/finos-labs/open-financial-llms-leaderboard/wiki). | |
| * Keep commits small and cohesive - if you have multiple contributions, please submit them as independent commits (and ideally as independent PRs too). | |
| * Reference issues if your PR has anything to do with an issue (even if it doesn't address it). | |
| * Minimise non-functional changes (e.g. whitespace). | |
| * Ensure all new files include a header comment block containing the [Apache License v2.0 and your copyright information](http://www.apache.org/licenses/LICENSE-2.0#apply). | |
| * If necessary (e.g. due to 3rd party dependency licensing requirements), update the [NOTICE file](https://github.com/finos/open-financial-llms-leaderboard/blob/master/NOTICE) with any new attribution or other notices | |
| ### Commit and PR Messages | |
| * **Reference issues, wiki pages, and pull requests liberally!** | |
| * Use the present tense ("Add feature" not "Added feature") | |
| * Use the imperative mood ("Move button left..." not "Moves button left...") | |
| * Limit the first line to 72 characters or less |