From 9cdc8dd0300bf943eb7b2d71850671bfa31f0c73 Mon Sep 17 00:00:00 2001 From: cgunasree08 Date: Tue, 2 Sep 2025 16:53:59 +0530 Subject: [PATCH 1/4] Replace CONTRIBUTING.md file with standard template for Workstation Signed-off-by: cgunasree08 --- CONTRIBUTING.md | 53 ++----------------------------------------------- 1 file changed, 2 insertions(+), 51 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a4d9b288..a372d41c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,52 +1,3 @@ -Contributing to ChefSpec -======================== -Pull requests are merged via Github, you can find the documentation about how to fork a repository and start contributing to ChefSpec here [https://help.github.com/articles/fork-a-repo](https://help.github.com/articles/fork-a-repo). +# Contributing to a Progress Chef Workstation Project -All contributions are welcome to be submitted for review for inclusion, but before they will be accepted, we ask that you follow these simple steps: - -* [Coding standards](#coding-standards) -* [Testing](#testing) -* [Documentation](#documentation) - -Also, please be patient as not all items will be tested or reviewed immediately by the core team. - -Please be receptive and responsive to feedback about your additions or changes. The core team and/or other community members may make suggestions or ask questions about your change. This is part of the review process, and helps everyone to understand what is happening, why it is happening, and potentially optimizes your code. - -If you're looking to contribute but aren't sure where to start, check out the [open issues](https://github.com/chefspec/chefspec/issues?state=open). - - -Will Not Merge --------------- -This section details, specifically, Pull Requests or features that will _not_ be merged: - -1. Matchers for non-Chef core resources. ChefSpec 3.0 introduced a way for cookbook maintainers to [package matchers _with_ their cookbooks](https://github.com/chefspec/chefspec#packaging-custom-matchers) at distribution time. -2. New features without accompanying unit tests, cucumber tests, and documentation. - - -Coding Standards ----------------- -The submitted code should be compatible with the standard Ruby coding guidelines. Here are some additional resources: - - * [Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide) - * [Github Styleguide](https://github.com/styleguide/ruby) - -There is a tool called [Cane](https://github.com/square/cane) that allows you to validate your code's ABC complexity and documentation. - - -Testing -------- -Whether your pull request is a bug fix or introduces new classes or methods to the project, we kindly ask that you include tests for your changes. Even if it's just a small improvement, a test is necessary to ensure the bug is never re-introduced. - -We understand that not all users submitting pull requests will be proficient with RSpec. The maintainers and community as a whole are a helpful group and can help you with writing tests. The [Better Specs](http://betterspecs.org/) site should provide some helpful resources to get you started. - -ChefSpec is tested on [Travis CI](https://travis-ci.org/chefspec/chefspec) against multiple Chef Versions and Ruby Versions. **Your patches must work for all Chef and Ruby Versions on Travis.** This is in an effort to maintain backward compatibility as long as possible. For more information on which Chef and Ruby versions to support, checkout the [`.travis.yml`](https://github.com/chefspec/chefspec/blob/master/.travis.yml) file. - - -Documentation -------------- -Documentation is a crucial part to ChefSpec, especially given its broad depth of features. All documentation is placed inline on the method matcher so it can be generated with Yard. Please see existing matchers for an example and check out the [Yard documentation](http://yardoc.info) - -When contributing new features, please ensure adequate documentation and examples are present. - ---- -This contributing guide is based off of the [Joomla Contributing Guide](https://raw.github.com/joomla/joomla-framework/master/CONTRIBUTING.markdown). +Thank you for your interest in contributing to this project! It is part of the larger Progress Chef Workstation project. Contribution guidelines can be found at [Contributing to Progress Chef Workstation](https://chef.github.io/chef-oss-practices/workstation/inspec/contributing/). \ No newline at end of file From 3ce104f3f28309a26d798a8b5aece72f11a5028e Mon Sep 17 00:00:00 2001 From: cgunasree08 Date: Wed, 3 Sep 2025 21:17:10 +0530 Subject: [PATCH 2/4] Move 'Ill Not Merge' and 'Testing' sections from CONTRIBUTING.md to README.md Signed-off-by: cgunasree08 --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index f38faa02..2f2f85cc 100644 --- a/README.md +++ b/README.md @@ -616,3 +616,19 @@ If you are contributing, please see the [Contributing Guidelines](https://github ## License MIT - see the accompanying [LICENSE](https://github.com/chefspec/chefspec/blob/main/LICENSE) file for details. + + +## Will Not Merge + +This section details, specifically, Pull Requests or features that will _not_ be merged: + +1. Matchers for non-Chef core resources. ChefSpec 3.0 introduced a way for cookbook maintainers to [package matchers _with_ their cookbooks](https://github.com/chefspec/chefspec#packaging-custom-matchers) at distribution time. +2. New features without accompanying unit tests, cucumber tests, and documentation. + + + +## Testing + +Whether your pull request is a bug fix or introduces new classes or methods to the project, we kindly ask that you include tests for your changes. Even if it's just a small improvement, a test is necessary to ensure the bug is never re-introduced. + +We understand that not all users submitting pull requests will be proficient with RSpec. The maintainers and community as a whole are a helpful group and can help you with writing tests. The [Better Specs](http://betterspecs.org/) site should provide some helpful resources to get you started. \ No newline at end of file From 8cd0c3211ae428c14519fb1a3078c34210bab5e0 Mon Sep 17 00:00:00 2001 From: cgunasree08 Date: Thu, 4 Sep 2025 19:57:58 +0530 Subject: [PATCH 3/4] Update section title Signed-off-by: cgunasree08 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2f2f85cc..2141b762 100644 --- a/README.md +++ b/README.md @@ -618,7 +618,7 @@ If you are contributing, please see the [Contributing Guidelines](https://github MIT - see the accompanying [LICENSE](https://github.com/chefspec/chefspec/blob/main/LICENSE) file for details. -## Will Not Merge +## Changes that will not be accepted This section details, specifically, Pull Requests or features that will _not_ be merged: From 8a9ea3c9b4d2cf432b17854dabf350e2e34e1e6c Mon Sep 17 00:00:00 2001 From: cgunasree08 Date: Sun, 7 Sep 2025 17:09:38 +0530 Subject: [PATCH 4/4] Correct Guidelines link Signed-off-by: cgunasree08 --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a372d41c..7f5d065f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,3 @@ # Contributing to a Progress Chef Workstation Project -Thank you for your interest in contributing to this project! It is part of the larger Progress Chef Workstation project. Contribution guidelines can be found at [Contributing to Progress Chef Workstation](https://chef.github.io/chef-oss-practices/workstation/inspec/contributing/). \ No newline at end of file +Thank you for your interest in contributing to this project! It is part of the larger Progress Chef Workstation project. Contribution guidelines can be found at [Contributing to Progress Chef Workstation](https://chef.github.io/chef-oss-practices/projects/workstation/contributing/). \ No newline at end of file