Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CONTRIBUTING.md and update the test project's README.md #12

Merged
merged 1 commit into from
Jan 26, 2025
Merged

Add CONTRIBUTING.md and update the test project's README.md #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Contributing

Contributions are welcome. Feel free to submit a pull request.

If you're not sure about something, open an issue first to discuss it.

To make sure your pull request goes smoothly, please follow these guidelines:
1. Run the tests before submitting your pull request. If you're adding a new feature, add a test for it.
2. Follow the existing code style as much as possible.
3. Make sure your code is formatted with `dotnet format`. The GitHub Action will fail if dotnet format results in any changes.

4 changes: 0 additions & 4 deletions Npgmq.Test/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@
This project contains the tests for the Npgmq library.
It spins up a PostgreSQL server in docker, installs the necessary extensions, creates a database, and runs the tests against it.

## Configration

The tests require a connection string, named `Test`, to be configured.

## Helper Scripts

### Start database, run tests, and stop database (All in one)
Expand Down
1 change: 1 addition & 0 deletions Npgmq.sln
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
global.json = global.json
.editorconfig = .editorconfig
.gitignore = .gitignore
CONTRIBUTING.md = CONTRIBUTING.md
EndProjectSection
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "workflows", "workflows", "{8C37002D-05C6-4B1F-B4FC-C2F45C5E5328}"
Expand Down
Loading