Git_Mirror/Terminal.Gui
1
0
Fork 0
mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2025-12-26 15:57:56 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2397 from tig/v1_contributing

Browse Source 
Partially fixes #2391 - Updated readmes to note v1 is now in Maintenace mode
This commit is contained in:
Tig
2023-03-03 15:27:26 -07:00
committed by GitHub
parent dae1c26cb7 06bd8cd1ff
commit da18332182
2 changed files with 20 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
CONTRIBUTING.md
View File

@@ -8,10 +8,13 @@ We welcome contributions from the community. See [Issues](https://github.com/gui
## Forking and Submitting Changes
*IMPORTANT*: v1.x of Terminal.Gui is now in maintenance mode. All new development is happening on the `v2_develop` branch. See the V2 discussion [here](https://github.com/gui-cs/Terminal.Gui/discussions/1940).
Terminal.Gui uses the [GitFlow](https://nvie.com/posts/a-successful-git-branching-model/) branching model.
* The `main` branch is always stable, and always matches the most recently released Nuget package.
* The `develop` branch is where new development and bug-fixes happen. It is the default branch.
* The `develop` branch is where bug-fixes to v1.x happens. It is the default branch.
* The `v2_develop` branch is where development on v2.x happens.
### Forking Terminal.Gui
@@ -33,16 +36,23 @@ You now have your own fork and a local repo that references it as `origin`. Your
### Starting to Make a Change
Ensure your local `develop` branch is up-to-date with `upstream` (`github.com/gui-cs/Terminal.Gui`):
Figure out if your change will target v1 or v2. If you're not sure, ask in the [v2 disucssions here](https://github.com/gui-cs/Terminal.Gui/discussions/1940).
For v1.x, use the `develop` branch. For v2.x, use the `v2_develop` branch.
Prefix any local branches you create with `v1_` or `v2_` to indicate which version you're working on.
Ensure your local branch is up-to-date with `upstream` (`github.com/gui-cs/Terminal.Gui`):
```powershell
cd ./Terminal.Gui
git checkout develop
git pull upstream develop
git checkout <develop/v2_develop>
git pull upstream <develop/v2_develop>
```
Create a new local branch:
```powershell
git checkout -b my_new_branch
git checkout -b <v1/v2>_my_new_branch
```
#### Making Changes
@@ -90,6 +100,10 @@ remote:
Follow the template instructions found on Github.
If you are targetting v2, set the project to the [v2 Project](https://github.com/orgs/gui-cs/projects/1).
4. If your change is a bug fix, consider whether you should submit a separate PR to the v1 (`develop`) or v2 (`v2_develop`) branch as well.
## Terminal.Gui Coding Style
**Terminal.Gui** follows the [Mono Coding Guidelines](https://www.mono-project.com/community/contributing/coding-guidelines/). [`/.editorconfig`](https://github.com/gui-cs/Terminal.Gui/blob/b0a43ba338adf5ec069066e5a7dff8fea39b41db/.editorconfig) enforces this style in Visual Studio. Use `Ctrl-K-D` in Visual Studio to have it reformat code.

1
README.md
View File

@@ -6,6 +6,7 @@
[![License](https://img.shields.io/github/license/gui-cs/gui.cs.svg)](LICENSE)
![Bugs](https://img.shields.io/github/issues/gui-cs/gui.cs/bug)
*IMPORTANT*: v1.x of Terminal.Gui is now in maintenance mode; we will accept PRs for v1.x (the `develop` branch) only for bugs that impact existing functionality. All new development happens on the `v2_develop` branch. See the V2 discussion [here](https://github.com/gui-cs/Terminal.Gui/discussions/1940).
# Terminal.Gui - Cross Platform Terminal UI toolkit for .NET
A toolkit for building rich console apps for .NET, .NET Core, and Mono that works on Windows, the Mac, and Linux/Unix.