Skip to content

Commit 6ae5725

Browse files
author
sam.gerene
committed
[Add] GH templates
1 parent 50cc457 commit 6ae5725

7 files changed

Lines changed: 166 additions & 0 deletions

File tree

.github/CODE_OF_CONDUCT.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at s.gerene@rheagroup.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

.github/CONTRIBUTING.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# How to contribute
2+
3+
We would like to start with saying thank you for wanting to contribute to UI-DSM codebase. We want to keep it as easy as possible to contribute changes that get things working in your environment. There are a few guidelines that we need contributors to follow so that we have a chance of keeping on top of things.
4+
5+
- [Making Changes](#making-changes)
6+
- [Handling Updates from Upstream/Development](#handling-updates-from-upstreamdevelopment)
7+
- [Sending a Pull Request](#sending-a-pull-request)
8+
- [Style Guidelines](#style-guidelines)
9+
10+
## Making Changes
11+
12+
1. [Fork](http://help.github.com/forking/) on GitHub
13+
1. Clone your fork locally
14+
1. Configure the upstream repo (`git remote add upstream git://github.com/RHEAGROUP/UI-DSM`)
15+
1. Checkout development
16+
1. Create a local branch (`git checkout -b myBranch`) from development
17+
1. Work on your feature
18+
1. Rebase if required (see below)
19+
1. Push the branch up to GitHub (`git push origin myBranch`)
20+
1. Send a Pull Request on GitHub
21+
22+
You should **never** work on a clone of master or development, and you should **never** send a pull request from master or development - always from a branch. The reasons for this are detailed below.
23+
24+
### Handling Updates from Upstream/Development
25+
26+
While you're working away in your branch it's quite possible that your upstream development (most likely the canonical UI-DSM version) may be updated. If this happens you should:
27+
28+
1. [Stash](http://git-scm.com/book/en/Git-Tools-Stashing) any un-committed changes you need to
29+
1. `git checkout development`
30+
1. `git pull upstream development`
31+
1. `git checkout myBranch`
32+
1. `git rebase development myBranch`
33+
1. `git push origin development` - (optional) this makes sure your remote development is up to date
34+
35+
This ensures that your history is "clean" i.e. you have one branch off from development followed by your changes in a straight line. Failing to do this ends up with several "messy" merges in your history, which we don't want. This is the reason why you should always work in a branch and you should never be working in, or sending pull requests from, development.
36+
37+
If you're working on a long running feature then you may want to do this quite often, rather than run the risk of potential merge issues further down the line.
38+
39+
### Sending a Pull Request
40+
41+
While working on your feature you may well create several branches, which is fine, but before you send a pull request you should ensure that you have rebased back to a single "Feature branch". We care about your commits, and we care about your feature branch; but we don't care about how many or which branches you created while you were working on it :smile:.
42+
43+
When you're ready to go you should confirm that you are up to date and rebased with upstream/development (see "Handling Updates from Upstream/development" above), and then:
44+
45+
1. `git push origin myBranch`
46+
1. Send a descriptive [Pull Request](https://help.github.com/articles/creating-a-pull-request/) on GitHub - making sure you have selected the correct branch in the GitHub UI!
47+
1. Wait for @samatrhea to merge your changes in.
48+
49+
And remember; **A pull-request with tests is a pull-request that's likely to be pulled in.** :grin: Bonus points if you document your feature in our [wiki](https://github.com/RHEAGROUP/UI-DSM/wiki) once it has been pulled in
50+
51+
## Style Guidelines
52+
53+
- Indent with 4 spaces, **not** tabs.
54+
- No underscore (`_`) prefix for member names.
55+
- Use `this` when accessing instance members, e.g. `this.Name = "UI-DSM";`.
56+
- Use the `var` keyword unless the inferred type is not obvious.
57+
- Use the C# type aliases for types that have them, e.g. `int` instead of `Int32`, `string` instead of `String` etc.
58+
- Use meaningful names (no hungarian notation), we like long descriptive names of methods, variables and parameters.
59+
- Wrap `if`, `else` and `using` blocks (or blocks in general, really) in curly braces, even if it's a single line.
60+
- Put `using` statements inside namespace.
61+
- Pay attention to whitespace and extra blank lines
62+
- Absolutely **no** regions
63+
64+
> If you are a ReSharper user, you can make use of our `.DotSettings` file to ensure you cover as many of our style guidelines as possible. There may be some style guidelines which are not covered by the file, so please pay attention to the style of existing code.

.github/ISSUE_TEMPLATE.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
### Prerequisites
2+
3+
- [ ] I have written a descriptive issue title
4+
- [ ] I have verified that I am running the latest version of the UI-DSM
5+
- [ ] I have searched [open](https://github.com/RHEAGROUP/UI-DSM/issues) and [closed](https://github.com/RHEAGROUP/UI-DSM/issues?q=is%3Aissue+is%3Aclosed) issues to ensure it has not already been reported
6+
7+
### Description
8+
<!-- A description of the bug or feature -->
9+
10+
### Steps to Reproduce
11+
<!-- List of steps, sample code, failing test or link to a project that reproduces the behavior -->
12+
13+
### System Configuration
14+
<!-- Tell us about the environment where you are experiencing the bug -->
15+
16+
- UI-DSM version:
17+
- [ ] UI-DSM:
18+
- [ ] Other:
19+
- Environment (Operating system, version and so on):
20+
- .NET Framework version:
21+
- Additional information:
22+
23+
<!-- Thanks for reporting the issue to UI-DSM! -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
### Prerequisites
2+
3+
- [ ] I have written a descriptive pull-request title
4+
- [ ] I have verified that there are no overlapping [pull-requests](https://github.com/RHEAGROUP/UI-DSM/pulls) open
5+
- [ ] I have verified that I am following the UI-DSM [code style guidelines](https://raw.githubusercontent.com/RHEAGROUP/UI-DSM/master/.github/CONTRIBUTING.md)
6+
- [ ] I have provided test coverage for my change (where applicable)
7+
8+
### Description
9+
<!-- A description of the changes proposed in the pull-request -->
10+
11+
<!-- Thanks for contributing to UI-DSM! -->

.github/coverlet.runsettings

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<?xml version="1.0" encoding="utf-8" ?>
2+
<RunSettings>
3+
<DataCollectionRunSettings>
4+
<DataCollectors>
5+
<DataCollector friendlyName="XPlat Code Coverage">
6+
<Configuration>
7+
<Format>opencover</Format>
8+
</Configuration>
9+
</DataCollector>
10+
</DataCollectors>
11+
</DataCollectionRunSettings>
12+
</RunSettings>

NOTICE

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
UI-DSM
2+
Copyright 2022 RHEA System S.A.
3+
Copyright 2022 ATG Europe

Nuget.Config

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<configuration>
3+
<packageSources>
4+
<clear />
5+
<add key="api.nuget.org" value="https://api.nuget.org/v3/index.json" />
6+
</packageSources>
7+
</configuration>

0 commit comments

Comments
 (0)