stevenanthonyrevo/dotnetnotts-web

The new .NET Notts website written in Blazor

.NET Notts Website

The new .NET Notts website written in Blazor. You can find the site at it's temporary domain name here;

https://dotnetnotts.azurewebsites.net/

Contents

• Contributing
• Local Development
  • Building Locally
  • Running Locally
  • Running Tests
• Build Tool
• Branding

Contributing

Before contributing to this repository please follow the following steps. Also please check the contribution guidelines.

Step 1 - Check for any issue

Before making any changes, check to see if there are any issues describing the feature you want to add or the bug you want to fix.

If there isn't an issue for the change you want to make, raise one

In the case that an issue doesn't exist for the change you want to make, raise one and fill in all the details asked for in the template.

Step 2 - Comment on the issue you want to pick up

When you have found an issue, comment on it requesting that you want to pick up the issue. If you have raised the issue, you can comment straight away saying you are going to resolve the issue yourself.

The reason for this is we have many people wanting to make certain changes, and we are running a first-come rota on who gets the issue. The first person to ask on an issue gets to resolve it.

Step 3 - One of the owners will comment and set to in-progress

If you can pick up an issue, the owners of the repository will comment saying so and set a in-progress label on the issue.

Extra Notes

---

First come first served

We are managing the demand to contribute by allowing the first person to request addressing a change on an issue to be the person whose PR we will review.

Some issues can have multiple contributions, so please do ask on the issue if you can still contribute.

Please only pick up one issue at a time, and a maximum of two issues over October

There are many small changes available in the issues. This is to ensure there are plenty of issues available for different first time contributors to pick up.

Please don't address more than two issues in this repository.

Please be patient

The maintainers look after this repository in their free time outside of full time jobs. They also have other priorities and commitments. We will try to address issues and pull requests in a timely manner, but sometimes it will take a few days. Please be patient.

Local Development

Building Locally

To build the project use the command dotnet build in the terminal of your choice.

Running Locally

To run the project locally use the command dotnet run in the terminal of your choice. This make the site available on http://localhost:5000/. Access that address in the browser of your choice to see your local version of the website.

Running Tests

To run tests use the command dotnet test in the terminal of your choice. If you wish to test code coverage, you can also run dotnet test --collect:"XPlat Code Coverage".

Existing test suites can be found under the ./tests folder. As of writing, the tests consist of only unit-level / component-level tests written using bUnit.

If you are editing or adding new components, please consider adding or updating tests to reflect your changes!

Build Tool

GitHub Actions is set up to build and run tests from Pull Requests so that we can ensure the project builds and tests pass from any changes made within branches before they are merged in.

GitHub Actions is also used to deploy on merge into master.

Branding

We ask that you make your changes to the front end with the following branding guidelines in mind:

• Green Background / White Text

  • Background: #05BD9E
  • Foreground: #FFFFFF

• White Background / Black Text

  • Background: #FFFFFF
  • Foreground: #000000

Font: Bahnschrift