Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (30 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

49 lines (30 loc) · 1.96 KB

Contributing to TagzApp

Thank you for your interest in contributing to TagzApp! We welcome contributions from everyone.

Getting Started

To get started, follow these steps:

  1. Create an issue to explain the contribution you want to make or choose an existing issue you would like to help with.
  2. Fork the repository to your own GitHub account
  3. Clone the forked repository to your local machine or use a GitHub codespace
  4. Create a new branch for your changes.
  5. Make your changes and commit them locally.
  6. Push your changes to your forked repository on GitHub (ex: csharpfritz/TagzApp).
  7. Open a pull request to the main repository.

Running a local environment for development

The application has been updated to work with .NET Aspire and will start with a Postgres container and support for Mastodon. With the .NET CLI installed, you can start the application using:

dotnet run --project src/AppHost

If you have the Aspire CLI installed, you can run a local instance with:

aspire run

Code Style

We follow the Microsoft C# Coding Conventions for our C# code. Please make sure your code adheres to this style guide before submitting a pull request. Pull requests will not be accepted without a passing build with our GitHub actions.

Unit Tests

We use Xunit for our unit tests. Please make sure your changes include appropriate unit tests in the TagzApp.UnitTest project.

End-to-End Testing

We use xUnit and Playwright for our end-to-end tests. Please make sure your changes include appropriate end-to-end tests in the TagzApp.WebTest project.

Reporting Bugs

If you find a bug, please open an issue on the repository and include as much detail as possible about the bug and how to reproduce it.

Contact

If you have any questions or concerns, please contact Fritz at jeff@jeffreyfritz.com