Skip to content

Latest commit

 

History

History
112 lines (70 loc) · 5.89 KB

CONTRIBUTING.md

File metadata and controls

112 lines (70 loc) · 5.89 KB
Raw

Contributing to Marten

We take Pull Requests!

Before you send Pull Request

  1. Contact the contributors via the Discord channel or the Github Issue to make sure that this is issue or bug should be handled with proposed way. Send details of your case and explain the details of the proposed solution.
  2. Once you get approval from one of the maintainers, you can start to work on your code change.
  3. After your changes are ready, make sure that you covered your case with automated tests and verify that you have limited the number of breaking changes to a bare minimum.
  4. We also highly appreciate any relevant updates to the documentation.
  5. Make sure that your code is compiling and all automated tests are passing.

After you have sent Pull Request

  1. Make sure that you applied or answered all the feedback from the maintainers.
  2. We're trying to be as much responsive as we can, but if we didn't respond to you, feel free to ping us on the Discord channel.
  3. Pull request will be merged when you get approvals from at least 2 of the maintainers (and no rejection from others). Pull request will be tagged with the target Marten version in which it will be released. We also label the Pull Requests with information about the type of change.

Setup your work environment

We try to limit the number of necessary setup to a minimum, but few steps are still needed:

1. .NET Core SDK 6.0+

Available here

2. PostgreSQL 12 or above database

The fastest possible way to develop with Marten is to run PostgreSQL in a Docker container. Assuming that you have Docker running on your local box, type: docker-compose up or dotnet run --framework net6.0 -- init-db at the command line to spin up a Postgresql database withThe default Marten test configuration tries to find this database if no PostgreSQL database connection string is explicitly configured following the steps below:

PLV8

If you'd like to use Patching Api you need to enable the PLV8 extension inside of PostgreSQL for running JavaScript stored procedures for the nascent projection support.

Ensure the following:

  • The login you are using to connect to your database is a member of the postgres role
  • An environment variable of marten_testing_database is set to the connection string for the database you want to use as a testbed. (See the Npgsql documentation for more information about PostgreSQL connection strings ).

Help with PSQL/PLV8

  • On Windows, see this link for pre-built binaries of PLV8
  • On *nix, check marten-local-db for a Docker based PostgreSQL instance including PLV8.

Once you have the codebase and the connection string file, run the build command or use the dotnet CLI to restore and build the solution.

You are now ready to contribute to Marten.

Node.js

If you want to update or add new documentation, you need to have Node.js installed on your machine. The recommended version is the latest LTS version. You can download it from the official website or using a version manager like nvm.

After installing Node.js, you can install the required packages by running the following command in the root directory of this repository:

npm install

Working with the Git

  1. Fork the repository.
  2. Create a feature branch from the master branch.
  3. We're not squashing the changes and using rebase strategy for our branches (see more in Git documentation). Having that, we highly recommend using clear commit messages. Commits should also represent the unit of change.
  4. Before sending PR to make sure that you rebased the latest master branch from the main Marten repository.
  5. When you're ready to create the Pull Request on GitHub.

Code style

Coding rules are set up in the .editorconfig file. This file is supported by all popular IDE (eg. Microsoft Visual Studio, Rider, Visual Studio Code) so if you didn't disable it manually they should be automatically applied after opening the solution. We also recommend turning automatic formatting on saving to have all the rules applied.

Documentation

If you want to update or add new documentation, you can find the documentation in the docs directory.

We're using MarkdownSnippets to include the C# code examples in the documentation.

If you want to add code examples to the documentation, you have to add a C# file which includes the code example or annotate existing files with a unique C# #region/#endregion pair:

#region sample_my_unique_name
// Your code example here
#endregion

Then you can refer to the code example in the Markdown file by using the following syntax:

Referring the code example

After adding the code example, you can run the following command to update the documentation:

npm run mdsnippets

You can find examples if you search this repository for "sample_" or "snippet:".

Licensing and legal rights

By contributing to Marten:

  1. You assert that contribution is your original work.
  2. You assert that you have the right to assign the copyright for the work.
  3. You are accepting the License.

Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.