From d95ffa4f68dc0365605bfe8c5e25fa4024399646 Mon Sep 17 00:00:00 2001 From: Matthew Erbs Date: Thu, 31 Aug 2017 20:36:30 +1000 Subject: [PATCH 1/3] Added Code of Conduct * Reference - https://www.contributor-covenant.org/: --- CODE_OF_CONDUCT.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..ac66f3ce4 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,46 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +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. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Our Responsibilities + +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. + +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. + +## Scope + +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. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team on the Gitter Channel - [![Join the chat at https://gitter.im/serilog/serilog](https://img.shields.io/gitter/room/serilog/serilog.svg)](https://gitter.im/serilog/serilog). 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. + +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. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ From 5bdde89bb4df7e75ab52054906b61a24da320089 Mon Sep 17 00:00:00 2001 From: Matthew Erbs Date: Mon, 4 Sep 2017 21:03:53 +1000 Subject: [PATCH 2/3] Removed detailed code in favour of Contributor Covenant link. --- CODE_OF_CONDUCT.md | 45 ++++++--------------------------------------- README.md | 5 +++-- 2 files changed, 9 insertions(+), 41 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index ac66f3ce4..6b8390594 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,46 +1,13 @@ -# Contributor Covenant Code of Conduct +# Code of Conduct -## Our Pledge - -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. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment include: - -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -* The use of sexualized language or imagery and unwelcome sexual attention or advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a professional setting - -## Our Responsibilities - -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. - -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. - -## Scope - -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. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team on the Gitter Channel - [![Join the chat at https://gitter.im/serilog/serilog](https://img.shields.io/gitter/room/serilog/serilog.svg)](https://gitter.im/serilog/serilog). 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. - -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. +The [Serilog Organization](https://github.com/serilog), its related [sinks][sinks] and [community projects][projects] have adopted the code of conduct defined by the [Contributor Covenant](http://contributor-covenant.org/) +to clarify expected behavior in our community. ## Attribution -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] +The Code of Conduct referenced can be found at the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]. [homepage]: http://contributor-covenant.org [version]: http://contributor-covenant.org/version/1/4/ +[projects]: https://github.com/serilog/serilog/wiki/Community-Projects +[sinks]: https://github.com/serilog/serilog/wiki/Provided-Sinks diff --git a/README.md b/README.md index 609f36a67..d8cb95e65 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,6 @@ public class Program } ``` - Find more, including a runnable example application, under the [Getting Started topic](https://github.com/serilog/serilog/wiki/Getting-Started) in the [documentation](https://github.com/serilog/serilog/wiki/). ### Getting help @@ -98,7 +97,9 @@ Serilog has an active and helpful community who are happy to help point you in t ### Contributing -Would you like to help make Serilog even better? We keep a list of issues that are approachable for newcomers under the [up-for-grabs](https://github.com/serilog/serilog/issues?labels=up-for-grabs&state=open) label. Before starting work on a pull request, we suggest commenting on, or raising, an issue on the issue tracker so that we can help and coordinate efforts. +Would you like to help make Serilog even better? We keep a list of issues that are approachable for newcomers under the [up-for-grabs](https://github.com/serilog/serilog/issues?labels=up-for-grabs&state=open) label. Before starting work on a pull request, we suggest commenting on, or raising, an issue on the issue tracker so that we can help and coordinate efforts. For more details check out our [contributing guide](CONTRIBUTING.md). + +When contributing please keep in mind our [Code of Conduct](CODE_OF_CONDUCT.md). ### Detailed build status From 279d51c833ddcd495ac09260c1e67e866a36486c Mon Sep 17 00:00:00 2001 From: Matthew Erbs Date: Mon, 4 Sep 2017 21:05:00 +1000 Subject: [PATCH 3/3] #842 Added issue and PR templates. Also added contrib guidelines. --- .github/ISSUE_TEMPLATE.md | 27 +++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 11 ++++++ CONTRIBUTING.md | 66 ++++++++++++++++++++++++++++++++ 3 files changed, 104 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..079407b40 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,27 @@ +**A few questions before you begin:** + +> Is this an issue related to the Serilog core project or one of the [sinks](https://github.com/serilog/serilog/wiki/Provided-Sinks) or [community projects](https://github.com/serilog/serilog/wiki/Community-Projects). This issue list is intended for Serilog core issues. If this issue relates to a sink or related project, please log on the related repository. Please use [Gitter chat](https://gitter.im/serilog/serilog) and [Stack Overflow](http://stackoverflow.com/questions/tagged/serilog) for discussions and questons. + + +**Does this issue relate to a new *feature* or an existing *bug*?** +- [ ] Bug +- [ ] New Feature + +**What version of Serilog is affected? Please list the related NuGet package.** + + +**What is the target framework and operating system? See [target frameworks](https://docs.microsoft.com/en-us/nuget/schema/target-frameworks) & [net standard matrix](https://docs.microsoft.com/en-us/dotnet/standard/net-standard).** + +- [ ] netCore 2.0 +- [ ] netCore 1.0 +- [ ] 4.7 +- [ ] 4.6.x +- [ ] 4.5.x + +**Please describe the current behavior?** + + +**Please describe the expected behavior?** + + +**If the current behavior is a bug, please provide the steps to reproduce the issue and if possible a minimal demo of the problem** diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..8eda4fcfd --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,11 @@ +**What issue does this PR address?** + + +**Does this PR introduce a breaking change?** + + +**Please check if the PR fulfills these requirements** +- [ ] The commit follows our [guidelines](https://github.com/serilog/serilog/CONTRIBUTING.md) +- [ ] Unit Tests for the changes have been added (for bug fixes / features) + +**Other information**: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..469adfc06 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,66 @@ +# Contributing to the Serilog project + +It's awesome that you are considering contributing to the Serilog project. As can be witnessed by the list of [sinks](https://github.com/serilog/serilog/wiki/Provided-Sinks) and [community projects](https://github.com/serilog/serilog/wiki/Community-Projects), it is people like yourself that make the Serilog ecosystem great to use. + +The following are a set of guidelines for contributing to [Serilog](https://serilog.net/) and its related packages, which are hosted in the [Serilog Organization](https://github.com/serilog) on GitHub. We are an ever evolving community, so feel free to propose changes to this document via a pull request. + + +## 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 which 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. + +Serilog caters a vast set of technologies and stacks that encounter a wide range of problems. As such we need your help! This help can be in many forms such as PRs, documentation updates or testing new releases. + +We keep a list of issues that are approachable for newcomers under the [up-for-grabs](https://github.com/serilog/serilog/issues?labels=up-for-grabs&state=open) label. Before starting work on a pull request, we suggest commenting on an existing issue or raising an issue to ensure we all work together towards a better Serilog. + +## Reporting an issue + +Bugs are tracked via [GitHub][issue_list] issues. Below are some notes to help create an issue. The issue template will help you on the way + +* Create an issue via the [issues list][create_issue]. +* List the version of Serilog that is affected +* List the target framework and operating system +* If possible, provide a sample that reproduces the issue. + +## Requesting a feature/enhancement + +Feature as also tracked via [GitHub][issue_list] issues. Below are some notes to help create an issue. The issue template will help you on the way + +* Create an issue via the [issues list][create_issue]. +* List the version of Serilog that is affected +* List the target framework and operating system +* If possible, provide a sample that reproduces the issue. + +## Making a PR + +* If an issue does not already exist please create one via the issues list. +* Fork the repository and create a branch with a descriptive name. +* Attempt to make commits of logical units. +* When committing, please reference the issue the commit relates to. +* Run the build and tests. + * Windows platforms can use the `build.ps1` script + * nix/OSX platforms can use the `build.sh` script +* Create the PR, the PR template will help provide a stub of what information is required including: + * The issue this PR addresses + * Unit Tests for the changes have been added. + +## Questions? + +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) - 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) + + +Finally when contributing please keep in mind our [Code of Conduct](CODE_OF_CONDUCT.md). + + +[serilog]: https://github.com/serilog/serilog +[sinks]: https://github.com/serilog/serilog/wiki/Provided-Sinks +[community_projects]: https://github.com/serilog/serilog/wiki/Community-Projects +[create_issue]: https://github.com/serilog/serilog/issues/new +[issue_list]: https://github.com/serilog/serilog/issues/