Skip to content

Commit 04b97b4

Browse files
authored
Merge pull request #93 from tui-cs/tig/rename-gui-cs-to-tui-cs
Rename internal references: gui-cs → tui-cs
2 parents ce985f3 + e80d933 commit 04b97b4

7 files changed

Lines changed: 32 additions & 32 deletions

File tree

CONTRIBUTING.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Contributing to NStack
22

3-
We welcome contributions from the community. See [Issues](https://github.com/gui-cs/NStack/issues) for a list of open [bugs](https://github.com/gui-cs/NStack/issues?q=is%3Aopen+is%3Aissue+label%3Abug) and [enhancements](https://github.com/gui-cs/NStack/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement). Contributors looking for something fun to work on should look at issues tagged as:
3+
We welcome contributions from the community. See [Issues](https://github.com/tui-cs/NStack/issues) for a list of open [bugs](https://github.com/tui-cs/NStack/issues?q=is%3Aopen+is%3Aissue+label%3Abug) and [enhancements](https://github.com/tui-cs/NStack/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement). Contributors looking for something fun to work on should look at issues tagged as:
44

5-
- [good first issue](https://github.com/gui-cs/NStack/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
6-
- [up for grabs](https://github.com/gui-cs/NStack/issues?q=is%3Aopen+is%3Aissue+label%3Aup-for-grabs)
7-
- [help wanted](https://github.com/gui-cs/NStack/issues?q=is%3Aopen+is%3Aissue+label%3Aup-for-grabs)
5+
- [good first issue](https://github.com/tui-cs/NStack/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
6+
- [up for grabs](https://github.com/tui-cs/NStack/issues?q=is%3Aopen+is%3Aissue+label%3Aup-for-grabs)
7+
- [help wanted](https://github.com/tui-cs/NStack/issues?q=is%3Aopen+is%3Aissue+label%3Aup-for-grabs)
88

99
## Forking and Submitting Changes
1010

@@ -15,7 +15,7 @@ NStack uses the [GitFlow](https://nvie.com/posts/a-successful-git-branching-mode
1515

1616
### Forking NStack
1717

18-
1. Use GitHub to fork the `NStack` repo to your account (https://github.com/gui-cs/NStack/fork).
18+
1. Use GitHub to fork the `NStack` repo to your account (https://github.com/tui-cs/NStack/fork).
1919

2020
2. Clone your fork to your local machine
2121

@@ -27,13 +27,13 @@ Now, your local repo will have an `origin` remote pointing to `https://github.co
2727

2828
3. Add a remote for `upstream`:
2929
```
30-
git remote add upstream https://github.com/gui-cs/NStack
30+
git remote add upstream https://github.com/tui-cs/NStack
3131
```
3232
You now have your own fork and a local repo that references it as `origin`. Your local repo also now references the orignal NStack repo as `upstream`.
3333

3434
### Starting to Make a Change
3535

36-
Ensure your local `develop` branch is up-to-date with `upstream` (`github.com/gui-cs/NStack`):
36+
Ensure your local `develop` branch is up-to-date with `upstream` (`github.com/tui-cs/NStack`):
3737
```powershell
3838
cd ./NStack
3939
git checkout develop
@@ -92,57 +92,57 @@ Follow the template instructions found on Github.
9292

9393
## NStack Coding Style
9494

95-
**NStack** follows the [Mono Coding Guidelines](https://www.mono-project.com/community/contributing/coding-guidelines/). [`/.editorconfig`](https://github.com/gui-cs/NStack/blob/b0a43ba338adf5ec069066e5a7dff8fea39b41db/.editorconfig) enforces this style in Visual Studio. Use `Ctrl-K-D` in Visual Studio to have it reformat code.
95+
**NStack** follows the [Mono Coding Guidelines](https://www.mono-project.com/community/contributing/coding-guidelines/). [`/.editorconfig`](https://github.com/tui-cs/NStack/blob/b0a43ba338adf5ec069066e5a7dff8fea39b41db/.editorconfig) enforces this style in Visual Studio. Use `Ctrl-K-D` in Visual Studio to have it reformat code.
9696

9797
## User Experience Tenets
9898

9999
**NStack**, as a UI framework, heavily influences how console graphical user interfaces (GUIs) work. We use the following [tenets](https://ceklog.kindel.com/2020/02/10/tenets/) to guide us:
100100

101-
*NOTE: Like all tenets, these are up for debate. If you disagree, have questions, or suggestions about these tenets and guidelines submit an Issue using the [design](https://github.com/gui-cs/NStack/issues?q=is%3Aopen+is%3Aissue+label%3Adesign) tag.*
101+
*NOTE: Like all tenets, these are up for debate. If you disagree, have questions, or suggestions about these tenets and guidelines submit an Issue using the [design](https://github.com/tui-cs/NStack/issues?q=is%3Aopen+is%3Aissue+label%3Adesign) tag.*
102102

103103
1. **Honor What's Come Before**. The Mac and Windows OS's have well-established GUI idioms that are mostly consistent. We adhere to these versus inventing new ways for users to do things. For example, **NStack** adopts the `ctrl/command-c`, `ctrl/command-v`, and `ctrl/command-x` keyboard shortcuts for cut, copy, and paste versus defining new shortcuts.
104-
2. **Consistency Matters**. Common UI idioms should be consistent across the GUI framework. For example, `ctrl/command-q` quits/exits all modal views. See [Issue #456](https://github.com/gui-cs/NStack/issues/456) as a counter-example that should be fixed.
104+
2. **Consistency Matters**. Common UI idioms should be consistent across the GUI framework. For example, `ctrl/command-q` quits/exits all modal views. See [Issue #456](https://github.com/tui-cs/NStack/issues/456) as a counter-example that should be fixed.
105105
3. **Honor the OS, but Work Everywhere**. **NStack** is cross-platform, but we support taking advantage of a platform's unique advantages. For example, the Windows Console API is richer than the Unix API in terms of keyboard handling. Thus, in Windows pressing the `alt` key in a **NStack** app will activate the `MenuBar`, but in Unix, the user has to press the full hotkey (e.g. `alt-f`) or `F9`.
106106
4. **Keyboard first, Mouse also**. Users use consoles primarily with the keyboard; **NStack** is optimized for getting stuff done without using the Mouse. However, as a GUI framework, the Mouse is essential thus we strive to ensure that everything also works via the Mouse.
107107

108108
## Public API Tenets & Guidelines
109109

110110
**NStack** provides an API that is used by many. As the project evolves, contributors should follow these [tenets](https://ceklog.kindel.com/2020/02/10/tenets/) to ensure Consistency and backward compatibility.
111111

112-
*NOTE: Like all tenets, these are up for debate. If you disagree, have questions, or suggestions about these tenets and guidelines submit an Issue using the [design](https://github.com/gui-cs/NStack/issues?q=is%3Aopen+is%3Aissue+label%3Adesign) tag.*
112+
*NOTE: Like all tenets, these are up for debate. If you disagree, have questions, or suggestions about these tenets and guidelines submit an Issue using the [design](https://github.com/tui-cs/NStack/issues?q=is%3Aopen+is%3Aissue+label%3Adesign) tag.*
113113

114114
1. **Stand on the shoulders of giants.** Follow the [Microsoft .NET Framework Design Guidelines](https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/) where appropriate.
115115
2. **Don't Break Existing Stuff.** Avoid breaking changes to user behavior or the public API; instead, figure out how to implement new functionality in a similar way. If a breaking change can't be avoided, follow the guidelines below.
116116
3. **Fail-fast.** Fail-fast makes bugs and failures appear sooner, leading to a higher-quality framework and API.
117-
4. **Standards Reduce Complexity**. We strive to adopt standard API idoms because doing so reduces complexity for users of the API. For example, see Tenet #1 above. A counterexample is [Issue #447](https://github.com/gui-cs/NStack/issues/447).
117+
4. **Standards Reduce Complexity**. We strive to adopt standard API idoms because doing so reduces complexity for users of the API. For example, see Tenet #1 above. A counterexample is [Issue #447](https://github.com/tui-cs/NStack/issues/447).
118118

119119
### Include API Documentation
120120

121-
Great care has been provided thus far in ensuring **NStack** has great [API Documentation](https://gui-cs.github.io/NStack/api/NStack/NStack.html). Contributors have the responsibility of continuously improving the API Documentation.
121+
Great care has been provided thus far in ensuring **NStack** has great [API Documentation](https://tui-cs.github.io/NStack/api/NStack/NStack.html). Contributors have the responsibility of continuously improving the API Documentation.
122122

123123
- All public APIs must have clear, concise, and complete documentation in the form of [XML Documentation](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/).
124124
- Keep the `<summary></summary>` terse.
125125
- Use `<see cref=""/>` liberally to cross-link topics.
126126
- Use `<remarks></remarks>` to add more context and explanation.
127-
- For complex topics, provide conceptual documentation in the `docfx/articles` folder as a `.md` file. It will automatically get picked up and be added to [Conceptual Documentation](https://gui-cs.github.io/NStack/articles/index.html).
127+
- For complex topics, provide conceptual documentation in the `docfx/articles` folder as a `.md` file. It will automatically get picked up and be added to [Conceptual Documentation](https://tui-cs.github.io/NStack/articles/index.html).
128128
- Use proper English and good grammar.
129129

130130
## Breaking Changes to User Behavior or the Public API
131131

132-
- Tag all pull requests that cause breaking changes to user behavior or the public API with the [breaking-change](https://github.com/gui-cs/NStack/issues?q=is%3Aopen+is%3Aissue+label%3Abreaking-change) tag. This will help project maintainers track and document these.
133-
- Add a `<remark></remark>` to the XML Documentation to the code describing the breaking change. These will get picked up in the [API Documentation](https://gui-cs.github.io/NStack/api/NStack/NStack.html).
132+
- Tag all pull requests that cause breaking changes to user behavior or the public API with the [breaking-change](https://github.com/tui-cs/NStack/issues?q=is%3Aopen+is%3Aissue+label%3Abreaking-change) tag. This will help project maintainers track and document these.
133+
- Add a `<remark></remark>` to the XML Documentation to the code describing the breaking change. These will get picked up in the [API Documentation](https://tui-cs.github.io/NStack/api/NStack/NStack.html).
134134

135135
## Unit Tests
136136

137137
PRs should never cause code coverage to go down. Ideally, every PR will get the project closer to 100%. PRs that include new functionality (e.g. a new control) should have at least 70% code coverage for the new functionality.
138138

139-
**NStack** has an automated unit or regression test suite. See the [Testing wiki](https://github.com/gui-cs/NStack/wiki/Testing).
139+
**NStack** has an automated unit or regression test suite. See the [Testing wiki](https://github.com/tui-cs/NStack/wiki/Testing).
140140

141141
We analyze unit tests and code coverage on each PR push.
142142

143143
The code coverage of the latest released build (on NuGet) is shown as a badge at the top of `README.md`. Here as well:
144144

145-
![Code Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/gui-cs/90ef67a684cb71db1817921a970f8d27/raw/code-coverage.json)
145+
![Code Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/tui-cs/90ef67a684cb71db1817921a970f8d27/raw/code-coverage.json)
146146

147147
The project uses Fine Code Coverage to allow easy access to code coverage info on a per-component basis.
148148

NStack/NStack.csproj

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
<PackageTags>unicode, c#</PackageTags>
1111
<Title>NStack.Core</Title>
1212

13-
<PackageProjectUrl>https://github.com/gui-cs/NStack/</PackageProjectUrl>
14-
<RepositoryUrl>https://github.com/gui-cs/NStack.git</RepositoryUrl>
13+
<PackageProjectUrl>https://github.com/tui-cs/NStack/</PackageProjectUrl>
14+
<RepositoryUrl>https://github.com/tui-cs/NStack.git</RepositoryUrl>
1515
<RepositoryType>git</RepositoryType>
1616
<IncludeSymbols>true</IncludeSymbols>
1717
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
@@ -26,7 +26,7 @@
2626

2727
It starts with a new string type that is focused on Unicode code-points as opposed to the historical chars and UTF-16 encoding and introduces a utf8 string that supports slicing</Description>
2828
<PackageReleaseNotes>
29-
See https://github.com/gui-cs/NStack/releases
29+
See https://github.com/tui-cs/NStack/releases
3030
</PackageReleaseNotes>
3131

3232
<!-- Version numbers are automatically updated by gitversion when a release is released -->

NStack/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Doing so will update the `.csproj` files in your branch with version info, which
3939
## Deploying a new version of the NStack Nuget Library
4040

4141
To release a new version (e.g. with a higher `major`, `minor`, or `patch` value) tag a commit using `git tag` and then
42-
push that tag directly to the `main` branch on `github.com/gui-cs/NStack` (`upstream`).
42+
push that tag directly to the `main` branch on `github.com/tui-cs/NStack` (`upstream`).
4343

4444
The `tag` must be of the form `v<major>.<minor>.<patch>`, e.g. `v2.3.4`.
4545

@@ -101,12 +101,12 @@ git push --atomic upstream main v2.3.4
101101

102102
### 8) Monitor Github Actions to ensure the Nuget publishing worked.
103103

104-
https://github.com/gui-cs/NStack/actions
104+
https://github.com/tui-cs/NStack/actions
105105

106106
### 9) Check Nuget to see the new package version (wait a few minutes)
107107
https://www.nuget.org/packages/NStack.Core
108108

109-
### 10) Add a new Release in Github: https://github.com/gui-cs/NStack/releases
109+
### 10) Add a new Release in Github: https://github.com/tui-cs/NStack/releases
110110

111111
Generate release notes with the list of PRs since the last release
112112

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# NStack
22

3-
![Build](https://github.com/gui-cs/NStack/actions/workflows/build.yml/badge.svg)
3+
![Build](https://github.com/tui-cs/NStack/actions/workflows/build.yml/badge.svg)
44
[![Version](https://img.shields.io/nuget/v/NStack.Core.svg)](https://www.nuget.org/packages/NStack.Core)
55
[![Downloads](https://img.shields.io/nuget/dt/NStack.Core)](https://www.nuget.org/packages/NStack.Core)
6-
[![License](https://img.shields.io/github/license/gui-cs/NStack.svg)](LICENSE)
7-
![Bugs](https://img.shields.io/github/issues/gui-cs/NStack)
6+
[![License](https://img.shields.io/github/license/tui-cs/NStack.svg)](LICENSE)
7+
![Bugs](https://img.shields.io/github/issues/tui-cs/NStack)
88

9-
NOTE: NStack has moved to the [gui-cs org](https://github.com/orgs/gui-cs/).
9+
NOTE: NStack has moved to the [tui-cs org](https://github.com/orgs/tui-cs/).
1010

1111
Currently, this library contains a port of the Go string, and Go rune support as well as other Unicode helper methods.
1212

13-
You can browse the [API documentation](https://gui-cs.github.io/NStack).
13+
You can browse the [API documentation](https://tui-cs.github.io/NStack).
1414

1515
Install the [NuGet package from NuGet.org](https://www.nuget.org/packages/NStack.Core) by installing `NStack.Core`.
1616

docfx/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
This folder generates the API docs for NStack.
22

3-
The API documentation is generated via a GitHub Action (`.github/workflows/api-docs.yml`) using [DocFX](https://github.com/dotnet/docfx). The Action publishes the docs to the `gh-pages` branch, which gets published to https://gui-cs.github.io/NStack/.
3+
The API documentation is generated via a GitHub Action (`.github/workflows/api-docs.yml`) using [DocFX](https://github.com/dotnet/docfx). The Action publishes the docs to the `gh-pages` branch, which gets published to https://tui-cs.github.io/NStack/.
44

55
## To Generate the Docs Locally
66

docfx/docfx.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@
7070
"_appLogoPath": "images/logo48.png",
7171
"_disableContribution": false,
7272
"_gitContribute": {
73-
"repo": "https://github.com/gui-cs/NStack",
73+
"repo": "https://github.com/tui-cs/NStack",
7474
"branch": "develop",
7575
"apiSpecFolder": "docfx/overrides"
7676
},

docfx/toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@
44
href: api/NStack/
55
homepage: api/NStack/NStack.html
66
- name: Source
7-
href: https://github.com/gui-cs/NStack
7+
href: https://github.com/tui-cs/NStack

0 commit comments

Comments
 (0)