A big welcome and thank you for considering contributing to Mews.Fiscalizations open source projects!
Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing these open source projects. In return, we will reciprocate that respect by addressing your issue, assessing changes, and helping you finalize your pull requests.
We take our open source community seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our Code of Conduct.
Contributions are made to this repo via Issues and Pull Requests (PRs). A few general guidelines that cover both:
- To report a bug or request a feature, please create an issue and follow the issue template guidelines.
- Search for existing Issues and PRs before creating your own.
Issues should be used to report problems with the library, request a new feature, or to discuss potential changes before a PR is created. When you create a new Issue, a template will be loaded that will guide you through collecting and providing the information we need to investigate.
If you find a github Issue that addresses the problem you're having, please add your own reproduction information to the existing issue rather than creating a new one. Adding a reaction can also help be indicating to our maintainers that a particular problem is affecting more than just the reporter.
PRs to our libraries are always welcome and can be a quick way to get your fix or improvement deployed in the next release. In general, PRs should:
- Follow single responsibility principle, i.e. solving one and exactly one thing. If your PR consists of multiple different changes, split it into separate PRs.
- Every PR should have a description, explaining mainly what has changed and why, so that any developer can quickly understand the purpose of PR without necessarily being involved in every preceding discussion, decisions etc. There is a template set up, so you can follow it.
- Add or update unit tests for fixed or changed functionality (if a test suite already exists).
- Title of the PR should be explanatory.
- Update the documentation in the repo if applicable.
- Every PR should be mergeable.
- Every PR should pass all the actions (tests/security scans..etc).
For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes.
Most important rule is that code should be:
- Simple = Easy to understand
- Correct
- Fast
Before making a PR, please follow these guidelines to make sure you follow our coding principles:
- We write clean code, so we don't just review if the code works, we review how it looks and if it follows our code style rules.
- We don't just look at what the code does, but also what the code could be doing. So it should not be possible to use the code in an intentionally bad way.
- We use functional programming principles, please consider taking a look at the library we use FuncSharp.
- We prefer type guarantees over code-checks.
- We use immutable DTOs.
- All endpoints should be Asynchronous.