Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
NoTitle: true
---
# Important files in the ReactiveUI repository

## directory.build.props
* https://github.com/reactiveui/ReactiveUI/blob/develop/src/Directory.build.props
* Used to define common properties (Copyright, PackageLicenseUrl, PackageTags) used in packaging projects.
Expand Down
5 changes: 1 addition & 4 deletions reactiveui/contribute/compiling-reactive-ui/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
---
NoTitle: true
Title: Compiling
---
# Compiling

0. ReactiveUI will not build correctly on Visual Studio for Mac as of 22/08/2017 building for multiple TFM's is not implemented nor working in Visual Studio for Mac. Only netstandard is compiled.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
---
NoTitle: true
Title: Troubleshooting
---
# Troubleshooting

## Binary Logging
ReactiveUI [uses the binary logger feature](https://github.com/reactiveui/ReactiveUI/blob/72b4921d0b60d55b795474c2f7a03918a85fb150/build.cake#L214) which was made available from msbuild v15.3 onwards to output all build events to a structured/binary log file.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
---
NoTitle: true
Title: Grammar and Mechanics
---
# Grammar and Mechanics

Adhering to certain rules of grammar and mechanics helps us keep our writing clear and consistent. This section will lay out our house style, which applies to all of our content unless otherwise noted in this guide. (We cover a lot of ground in this section—the search feature will help if you're looking for something in particular.)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
NoTitle: true
Title: Principles For Content
Order: 0
---

## Principles
# Principles

Good content is:

Expand Down
5 changes: 1 addition & 4 deletions reactiveui/contribute/content-style-guide/voice-and-tone.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
---
NoTitle: true
Title: Voice and Tone
---
# Voice and Tone

One way we write empowering content is by being aware of our voice and our tone. This section explains the difference between voice and tone, and lays out the elements of each as they apply to ReactiveUI.

Expand Down
6 changes: 2 additions & 4 deletions reactiveui/contribute/content-style-guide/word-list.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
NoTitle: true
Title: Style Guide - Words
---
# Style Guide - Words

These words can be slippery. Here’s how we write them.

* add-on (noun, adjective), add on (verb)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
---
NoTitle: true
Title: Writing About People
---
## Writing About People
# Writing About People

We write the same way we build apps: with a person-first perspective. Whether you’re writing for an internal or external audience, it's important to write for and about other people in a way that’s compassionate, inclusive, and respectful. Being aware of the impact of your language will help make ReactiveUI a better open-source project. In this section we'll lay out some guidelines for writing about people with compassion, and share some resources for further learning.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
NoTitle: true
Title: Blogging Guidelines
---
# Blogging Guidelines

ReactiveUI's blog posts are written by people from from all walks of life. We love having maintainers, contributors and businesses blog about their experiences with programming in an reactive manner. The person most familiar with the subject is in the best position to convey it.

## Basics
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
NoTitle: true
Title: Email Newsletters
---
# Email Newsletters

As devices shrink and the inbox evolves, the oldest tip is still the most important: Only send when you have something to say.

## Basics
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
NoTitle: true
Title: Social media
---
# Social media

We use social media to build relationships with ReactiveUI users and share all the cool stuff we do. But it also creates opportunities to say the wrong thing, put off developers, and damage our brand. So we’re careful and deliberate in what we post to our social channels. This section lays out how we strike that delicate balance.

## Basics
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
NoTitle: true
Title: Legal Content
---
# Legal Content

ReactiveUI publishes many kinds of legal content to protect ourselves and our users around the world. Most of our legal content is written by the .NET Foundation and their lawyers. This section gives a general overview of the types of legal content we publish and how those documents are written.

## Basics
Expand Down
3 changes: 2 additions & 1 deletion reactiveui/contribute/design/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
NoTitle: true
Order: 100
---
# Design

[See Design](https://github.com/reactiveui/website/issues?q=is%3Aissue+is%3Aopen+label%3Adesign)
6 changes: 2 additions & 4 deletions reactiveui/contribute/developer-experience/help-wanted.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
NoTitle: true
Title: Help Wanted
---
# Help Wanted

Read the plan first.

This page needs fleshing out, pretty much every interaction we have. If you have questions PR the answers here. It's the onboarding guide for other people who may wish to help with documentation:
Expand Down
2 changes: 1 addition & 1 deletion reactiveui/contribute/developer-experience/the-pitch.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
NoTitle: true
Order: 0
---
# The Pitch

Knowledge of reactive programming changes you as a developer, makes you better and aligns your career with where the industry is going. One of the cool things about reactive programming is that the knowledge is _universal across programming languages_.

Expand Down
4 changes: 2 additions & 2 deletions reactiveui/contribute/developer-experience/the-plan.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
NoTitle: true
Title: The Plan (tm)
Order: 100
---
# The Plan

ReactiveUI is the father of the extremely popular ReactiveCocoa AKA "RAC" (and also by extension ReactiveSwift) which literaly transformed and changed the way iOS software development is done. Whilst Anaïs was working at GitHub, the team behind ReactiveCocoa (also GitHub employees) ported the concepts behind ReactiveUI to iOS via much beer and coffee :-)

* https://github.com/ReactiveCocoa/ReactiveCocoa (19,975 stars, 3,565 forks)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
NoTitle: true
Title: Submitting a Pull Request
---
# Submitting a Pull Request

Before you submit your pull request, please:

* If you are considering submitting a pull-request that is more than a simple fix, open a discussion on GitHub first with your proposal.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
NoTitle: true
Title: Testing Your Changes
---
# Testing Your Changes

## Approval Tests
Approval tests are run to make sure that changes to the public API surface are known about.
Currently, this covers the Blend, Forms, Testing and .Net 462 / Net Core API surfaces.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
NoTitle: true
Title: Accountability-and-expectations
---
# Accountability-and-expectations

A great software engineering team is vital for the success of a Open Source Project.

Therefore, many resources, time, and knowledge go into improving their performance, making them more productive and creative, and rightfully so.
Expand Down
6 changes: 2 additions & 4 deletions reactiveui/contribute/maintainers/approval-tests.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
NoTitle: true
---
## Approval Tests
# Approval Tests

Approval tests are run to make sure that changes to the public API surface are known about.
Currently, this covers the Blend, Forms, Testing and .Net 462 and .Net 6 API surfaces.
These are included in `ReactiveUI.Tests\API\ApiApprovalTests.cs`.
Expand Down
5 changes: 2 additions & 3 deletions reactiveui/contribute/maintainers/avoiding-burnout.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
NoTitle: true
---
# Avoiding Burnout

* Don't go dark, use the weekly standup as an opportunity to ask for help or say that you'll be taking a break.
* https://docs.brew.sh/Maintainers-Avoiding-Burnout.html
* https://gist.github.com/ryanflorence/124070e7c4b3839d4573
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
NoTitle: true
---
# Semantic Versioning

Semantic versioning is all about releases, our continuous integration infrastructure uses [GitVersion](https://gitversion.readthedocs.io) to automatically version our releases [as per the configuration](https://github.com/reactiveui/ReactiveUI/blob/develop/GitVersion.yml).

For maintainer sanity, we version ReactiveUI and package as a pinned group - all packages in a release will always be the same version and only work with that version which makes it impossible for a consumer to run into situations where they use `reactiveui-core` at `7.1.0` but `reactiveui-xamforms` at `7.0.0`. Additionally all assemblies share the same [CommonAssemblyInfo.cs](https://github.com/reactiveui/ReactiveUI/blob/develop/src/CommonAssemblyInfo.cs) which is updated just before compile time by the build infrastructure.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
NoTitle: true
---
# Troubleshooting a failed release

## Version wasn't bumped when merging from develop into main

You'll need to do a pull-request similar to this [https://github.com/reactiveui/ReactiveUI/pull/1226](https://github.com/reactiveui/ReactiveUI/pull/1226)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
NoTitle: true
---
# Workflow for Creating a New Release

## Development

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
---
NoTitle: true
Title: Dealing with Angry, Negative, Problematic or Disruptive community members
---
# Dealing with Angry, Negative, Problematic or Disruptive community members

GitHub's [recent research](https://opensourcesurvey.org/2017/) has shown that even witnessing these negative interactions can be costing our project of consumers stepping up to become contributors:

Expand Down
7 changes: 4 additions & 3 deletions reactiveui/contribute/maintainers/merging-pull-requests.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
NoTitle: true
---
# Merging Pull Requests

When a pull-request is ready to be merged, please follow these steps to ensure a smooth and consistent process.

1. Assign one or more labels to categorize what component of ReactiveUI was changed by this unit of work. ![](~/images/apply-one-or-more-labels.png)

2. Rename the title of the GitHub issue to match [our convention](~/contribute/software-style-guide/commit-message-convention.md). ![](~/images/rename-the-title.png)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
NoTitle: true
---
# Minimum Supported Version

Be extremely conversative about bumping the minimum supported version of ReactiveUI and any dependencies such as splat or system.reactive. Please ensure that you aren't breaking the ecosystem, there's a migration path and no rift is created (python 2 vs python 3) that people can fall into.

With that said however this is an open-source project and typically folks who are stuck on older versions work at enterprise companies. Maintainers have zero obligations to requests from this demographic - our software is made available in binary and source form on a AS-IS basis. Often we will accomodate such requests to keep a platform around longer if the request comes from a maintainer or a respected community member who is actively engaged in helping make ReactiveUI better.
Expand Down

This file was deleted.

4 changes: 0 additions & 4 deletions reactiveui/contribute/maintainers/platform-knowledge/toc.yml

This file was deleted.

This file was deleted.

5 changes: 1 addition & 4 deletions reactiveui/contribute/maintainers/team-management.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
---
NoTitle: true
---
## Team Management
# Team Management

When a pull-request is created GitHub evaulates which files have been changed [as per these rules](https://github.com/reactiveui/ReactiveUI/blob/main/.github/CODEOWNERS
). For more information about the `CODEOWNERS` convention [refer to this page on GitHub](https://help.github.com/articles/about-codeowners/) or refer to the sample below
Expand Down
2 changes: 0 additions & 2 deletions reactiveui/contribute/maintainers/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@
href: merging-pull-requests.md
- name: Minimum Supported Version
href: minimum-supported-version.md
- name: platform-knowledge
href: platform-knowledge/toc.yml
- name: Reviewing pull requests
href: reviewing-pull-requests.md
- name: Team management
Expand Down
6 changes: 2 additions & 4 deletions reactiveui/contribute/maintainers/traiging-github-issues.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
NoTitle: true
Title: Triaging GitHub issues
---
# Triaging GitHub issues

@inherits StatiqRazorPage<IDocument>

<li><a href="https://github.com/reactiveui/ReactiveUI/pull/1448">housekeeping and proposal labels won't be autoclosed</a></li>
Expand Down
5 changes: 2 additions & 3 deletions reactiveui/contribute/marketing/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
NoTitle: true
---
# Marketing for Engineers

@inherits StatiqRazorPage<IDocument>

Website stats https://clicky.com/stats/?site_id=100909170
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
NoTitle: true
---
# Breaking Changes

Like we should make no assumptions that people even know what a breaking change is.... many people never had to worry about framework concerns before in their life.
provide some form of automation (approval tests) then link off to a (currently non-existent) document in the contribution section.
Expand Down
5 changes: 2 additions & 3 deletions reactiveui/contribute/software-style-guide/code-style.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
---
NoTitle: true
Order: 0
---
C# Style Guide
===============
# C# Style Guide


The general rule we follow is "use Visual Studio defaults".

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
NoTitle: true
---
# Commit Message Convention

Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
format that includes a **type** and a **subject**:

```
```xml
<type>: <subject>
<body>
<BLANK LINE>
Expand Down
5 changes: 2 additions & 3 deletions reactiveui/contribute/software-style-guide/license-headers.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
---
NoTitle: true
---
# License Headers

ReactiveUI projects use Stylecop and is installed from Nuget, all new files must have the license added to the top, the lack of the Header will result in a build failure. Please use the Stylecop Analyser suggestions to ensure the correct header is inserted.
4 changes: 1 addition & 3 deletions reactiveui/docs/getting-started/compelling-example.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
Title: A Compelling Example
---
# A Compelling Example

Let's create a simple application demonstrating a number of ReactiveUI functionalities, without getting into too many under-the-hood details. We will create a WPF application, which will allow us to search through NuGet public repositories. The full code of the application is shown at the end of this chapter, and we will show relevant snippets as we go.

Expand Down
1 change: 1 addition & 0 deletions reactiveui/docs/getting-started/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Getting Started with ReactiveUI

ReactiveUI gives you the power to build reactive, testable, and composable UI code using the MVVM pattern.

Expand Down
4 changes: 1 addition & 3 deletions reactiveui/docs/getting-started/installation/avalonia.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
Title: Avalonia
---
# Avalonia

<div class="youtube-video-container"><iframe src="https://www.youtube.com/embed/q6uWPtKw3UQ" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe></div>

Expand Down
4 changes: 1 addition & 3 deletions reactiveui/docs/getting-started/installation/blazor.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
Title: Blazor
---
# Blazor

# Package Installation

Expand Down
Loading
Loading