Skip to content

Commit 1d29005

Browse files
martincostellomartincostello
authored
Merge pull request #28 from martincostello/Update-Analyzers
Update analyzers and Community docs
2 parents d338c31 + eecbe25 commit 1d29005

13 files changed

+179
-17
lines changed

‎.github/CONTRIBUTING.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
To contribute changes (source code, scripts, configuration) to this repository please follow the steps below. These steps are a guideline for contributing and do not necessarily need to be followed for all changes.
2+
3+
1. If you intend to fix a bug please create an issue before forking the repository.
4+
1. Fork the `master` branch of this repository from the latest commit.
5+
1. Create a branch from your fork's `master` branch to help isolate your changes from any further work on `master`. If fixing an issue try to reference its name in your branch name (e.g. `issue-42`) to make changes easier to track the changes.
6+
1. Work on your proposed changes on your fork. If you are fixing an issue include at least one unit test that reproduces it if the code changes to fix it have not been applied; if you are adding new functionality please include unit tests appropriate to the changes you are making. The [code coverage figure](https://codecov.io/gh/martincostello/browserstack-automate) should be maintained where possible.
7+
1. When you think your changes are complete, test that the code builds cleanly using `Build.ps1`/`build.sh`. There should be no compiler warnings and all tests should pass.
8+
1. Once your changes build cleanly locally submit a Pull Request back to the `master` branch from your fork's branch. Ideally commits to your branch should be squashed before creating the Pull Request. If the Pull Request fixes an issue please reference it in the title and/or description. Please keep changes focused around a specific topic rather than include multiple types of changes in a single Pull Request.
9+
1. After your Pull Request is created it will build against the repository's continuous integrations.
10+
1. Once the Pull Request has been reviewed by the project's [contributors](https://github.com/martincostello/browserstack-automate/graphs/contributors) and the status checks pass your Pull Request will be merged back to the `master` branch, assuming that the changes are deemed appropriate.

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
### Expected behaviour
2+
3+
_Explain what you expected to happen._
4+
5+
### Actual behaviour
6+
7+
_Explain what actually happened. If an exception occurred, please include a stack trace if available._
8+
9+
### Steps to reproduce
10+
11+
_A concise and repeatable example of how to illustrate the issue, including any screenshots if relevant._

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Bug report
3+
about: Create a bug report to help us improve the library
4+
---
5+
6+
**Describe the bug**
7+
_A clear and concise description of what the bug is._
8+
9+
**Steps To reproduce**
10+
_A concise, repeatable, example of how to reproduce the issue._
11+
12+
**Expected behaviour**
13+
_A clear and concise description of what you expected to happen._
14+
15+
**Actual behaviour**
16+
_A clear and concise description of what actually happened. If an exception occurred, please include a stack trace if available._
17+
18+
**Screenshots**
19+
If applicable, add screenshots to help explain your problem.
20+
21+
**System information:**
22+
- OS: [e.g. Windows 10]
23+
- Library Version [e.g. 3.0.0]
24+
- .NET version [e.g. output from `dotnet --info`]
25+
26+
**Additional context**
27+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for a feature of this library
4+
5+
---
6+
7+
**Is your feature request related to a problem? Please describe.**
8+
A clear and concise description of what the problem is. For example: _I'm always frustrated when [...]_
9+
10+
**Describe the solution you'd like**
11+
A clear and concise description of what you want to happen.
12+
13+
**Describe alternatives you've considered**
14+
A clear and concise description of any alternative solutions or features you've considered.
15+
16+
**Additional context**
17+
Add any other context or screenshots about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
_Summarise the changes this Pull Request makes._
2+
3+
_Please include a reference to a GitHub issue if appropriate._

‎.github/stale.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
daysUntilStale: 56
2+
daysUntilClose: 7
3+
exemptLabels:
4+
- blocked
5+
- pinned
6+
- security
7+
staleLabel: wontfix
8+
markComment: >
9+
This issue has been automatically marked as stale because it has not had
10+
recent activity. It will be closed if no further activity occurs. Thank you
11+
for your contributions.
12+
closeComment: Closed automatically due to inactivity.

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
.DS_Store
22
.dotnetcli
3+
.idea
34
.metadata
45
.settings
56
.vs

‎Build.ps1‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,8 @@ function DotNetPack {
8383

8484
if ($VersionSuffix) {
8585
& $dotnet pack $Project --output $OutputPath --configuration $Configuration --version-suffix "$VersionSuffix" --include-symbols --include-source
86-
} else {
86+
}
87+
else {
8788
& $dotnet pack $Project --output $OutputPath --configuration $Configuration --include-symbols --include-source
8889
}
8990
if ($LASTEXITCODE -ne 0) {

‎CODE_OF_CONDUCT.md‎

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

‎Directory.Build.props‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
<ItemGroup>
33
<AdditionalFiles Include="$(MSBuildThisFileDirectory)stylecop.json" Link="stylecop.json" />
44
<Compile Include="$(MSBuildThisFileDirectory)CommonAssemblyInfo.cs" />
5-
<PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="2.6.1" PrivateAssets="All" />
6-
<PackageReference Include="Microsoft.CodeQuality.Analyzers" Version="2.6.1" PrivateAssets="All" />
7-
<PackageReference Include="Microsoft.NetCore.Analyzers" Version="2.6.1" PrivateAssets="All" />
5+
<PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="2.6.2" PrivateAssets="All" />
6+
<PackageReference Include="Microsoft.CodeQuality.Analyzers" Version="2.6.2" PrivateAssets="All" />
7+
<PackageReference Include="Microsoft.NetCore.Analyzers" Version="2.6.2" PrivateAssets="All" />
88
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0-beta-63127-02" PrivateAssets="All" />
99
<PackageReference Include="OpenCover" Version="4.6.519" PrivateAssets="All" />
1010
<PackageReference Include="ReportGenerator" Version="4.0.0-rc4" PrivateAssets="All" />
1111
<PackageReference Include="StyleCop.Analyzers" Version="1.0.2" PrivateAssets="All" />
12-
<PackageReference Include="Text.Analyzers" Version="2.6.1" PrivateAssets="All" />
12+
<PackageReference Include="Text.Analyzers" Version="2.6.2" PrivateAssets="All" />
1313
</ItemGroup>
1414
<PropertyGroup>
1515
<AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>

0 commit comments

Comments
 (0)