Skip to content

Commit

Permalink
chore(docs): Markdown housekeeping (#1969)
Browse files Browse the repository at this point in the history
* Remove gitter from CONTRIBUTING.md
* Remove year from copyright
* Add Copyright prop for package
* CloseAndFlushAsync comment
* More shepherding to SO
  • Loading branch information
bartelink committed Oct 26, 2023
1 parent a493ffd commit e37837e
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 7 deletions.
3 changes: 1 addition & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The following are a set of guidelines for contributing to [Serilog](https://seri

## Where to start?

The [Serilog repository][serilog] is the location for enhancements and fixes to the core library. Generally we try to keep the core library lean and performant while attempting to deliver the features of a first class logging library.
The [Serilog repository][serilog] is the location for enhancements and fixes to the core library. Generally we try to keep the core library lean and performant while attempting to deliver the features of a first class logging library.

If you are interested in contributing to a [sink][sinks] or one of the other [community projects][community_projects] then please create a PR in the respective repository.

Expand Down Expand Up @@ -52,7 +52,6 @@ Serilog has an active and helpful community who are happy to help point you in t

* [Stack Overflow](http://stackoverflow.com/questions/tagged/serilog) - this is the best place to start if you have a question
* Our [issue tracker](https://github.com/serilog/serilog/issues) here on GitHub
* [Gitter chat](https://gitter.im/serilog/serilog)
* The [#serilog tag on Twitter](https://twitter.com/search?q=%23serilog)


Expand Down
3 changes: 2 additions & 1 deletion Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@
<CheckEolTargetFramework>false</CheckEolTargetFramework>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
<Copyright>Copyright © 2013-23 Serilog Contributors</Copyright>
</PropertyGroup>
<ItemGroup Condition="'$(TargetFrameworkIdentifier)' == '.NETFramework'">
<Reference Include="System" />
<Reference Include="System.Core" />
<Reference Include="Microsoft.CSharp" />
</ItemGroup>
</Project>
</Project>
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ catch (Exception ex)
}
finally
{
await Log.CloseAndFlushAsync();
await Log.CloseAndFlushAsync(); // ensure all logs written before app exits
}
```

Expand All @@ -103,11 +103,12 @@ To learn more about Serilog, check out the [documentation](https://github.com/se

Serilog has an active and helpful community who are happy to help point you in the right direction or work through any issues you might encounter. You can get in touch via:

* [Stack Overflow](http://stackoverflow.com/questions/tagged/serilog) &mdash; this is the best place to start if you have a question
* [Stack Overflow](http://stackoverflow.com/questions/tagged/serilog) &mdash; this is the best place to start if you have a question. Many track the `serilog` tag there.
* The [#serilog tag on Twitter](https://twitter.com/search?q=%23serilog)
* [Serilog-related courses on Pluralsight](https://www.pluralsight.com/search/?q=serilog)

We welcome bug reports and suggestions through our [issue tracker](https://github.com/serilog/serilog/issues) here on GitHub.
We welcome reproducible bug reports and detailed feature requests through [our GitHub issue tracker](https://github.com/serilog/serilog/issues);
note the other resource are much better for quick questions or seeking usage help.

### Contributing

Expand All @@ -122,4 +123,4 @@ When contributing please keep in mind our [Code of Conduct](CODE_OF_CONDUCT.md).
| `dev` | [![Build status](https://ci.appveyor.com/api/projects/status/b9rm3l7kduryjgcj/branch/dev?svg=true)](https://ci.appveyor.com/project/serilog/serilog/branch/dev) |
| `main` | [![Build status](https://ci.appveyor.com/api/projects/status/b9rm3l7kduryjgcj/branch/master?svg=true)](https://ci.appveyor.com/project/serilog/serilog/branch/master) |

_Serilog is copyright &copy; 2013-2020 Serilog Contributors - Provided under the [Apache License, Version 2.0](http://apache.org/licenses/LICENSE-2.0.html). Needle and thread logo a derivative of work by [Kenneth Appiah](http://www.kensets.com/)._
_Serilog is copyright &copy; Serilog Contributors - Provided under the [Apache License, Version 2.0](http://apache.org/licenses/LICENSE-2.0.html). Needle and thread logo a derivative of work by [Kenneth Appiah](http://www.kensets.com/)._

0 comments on commit e37837e

Please sign in to comment.