-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'origin/develop'
- Loading branch information
Showing
23 changed files
with
797 additions
and
454 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| # 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, sex characteristics, gender identity and expression, | ||
| level of experience, education, socio-economic status, 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 at [email protected]. All | ||
| complaints will be reviewed and investigated and will result in a response that | ||
| is deemed necessary and 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
|
|
||
| [homepage]: https://www.contributor-covenant.org | ||
|
|
||
| For answers to common questions about this code of conduct, see | ||
| https://www.contributor-covenant.org/faq |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,29 +1,52 @@ | ||
|  | ||
|
|
||
| Thank you for Contributing | ||
| Contributing Guide | ||
| === | ||
|
|
||
| We want to make it as easy as possible to contribute changes. | ||
| Issues & Feature Requests | ||
| --- | ||
|
|
||
| Follow the requirements below for __[Creating Issues](https://github.com/sfccdevops/sfcc-cli/issues/new)__ and __[Pull Requests](https://github.com/sfccdevops/sfcc-cli/pull/new)__, to keep everything simple for everyone :) | ||
| [](https://github.com/sfccdevops/sfcc-devtools/issues/new/choose) | ||
|
|
||
| <img src="https://octodex.github.com/images/dinotocat.png" width="400" /> | ||
| ### Bug Fix | ||
|
|
||
| Creating an Issue | ||
| --- | ||
| > We're sorry things are not working as expected, and want to get things fixed ASAP. In order to help us do that, we need a few things from you. | ||
| 1. Create a [New Issue](https://github.com/sfccdevops/sfcc-devtools/issues/new/choose) | ||
| 2. Enter a Short but Descriptive Title for the Issue | ||
| 3. Use the Template Provided and fill in as much as you can, if something does not apply, enter `N/A` | ||
| 4. Look for the `Labels` section, and select `Bug Report` from the drop down menu | ||
| 5. Click `Submit new issue` button | ||
|
|
||
| ### Feature Request | ||
|
|
||
| Use the Prepopulated Template that we provide. Issues reported that do not use the template will be rejected. | ||
| > Got an idea for a new feature? We'd love to hear it! In order to get this knocked out, we will need a few things from you. | ||
| 1. Create a [New Issue](https://github.com/sfccdevops/sfcc-devtools/issues/new/choose) | ||
| 2. Enter a Short but Descriptive Title for the Feature Request | ||
| 3. Use the Template Provided and fill in as much as you can, if something does not apply, enter `N/A` ( you can delete the `Steps to Duplicate:` section as that does not apply ) | ||
| 4. Look for the `Labels` section, and select `Feature Request` from the drop down menu | ||
| 5. Click `Submit new issue` button | ||
|
|
||
| Creating a Pull Request | ||
| Pull Requests | ||
| --- | ||
|
|
||
| Before you can submit a PR, you will need to: | ||
| [](https://github.com/sfccdevops/sfcc-devtools/compare) | ||
|
|
||
| ### Bug Fix | ||
|
|
||
| > Each Bug Fix reported on GitHub should have its own `fix/*` branch. The branch name should be formatted `fix/###-issue-name` where `###` is the GitHub Issue Number, and `issue-name` is a 1-3 word summary of the issue. | ||
| 1. Checkout latest `develop` branch | ||
| 2. Pull down the latest changes via `git pull` | ||
| 3. Create a new branch with the structure `fix/*`, e.g. `fix/123-broken-form` | ||
| 4. When you are ready to submit your code, submit a new Pull Request that merges your code into `develop` | ||
| 5. Tag your new Pull Request with `Ready for Code Review` | ||
|
|
||
| ### Feature Request | ||
|
|
||
| 1. Make a New Branch off of `staging` ( ideally you will name your branch for the issue you are fixing, e,g, `issue-3-fixing-logger` ) | ||
| 2. Commit & Push your New Branch, with a comment like `Fixes #3` to auto trigger a status change for that issue | ||
| 3. Make your Pull Request into the `develop` | ||
| 4. Set `Reviewers` and `Assignees` to `Peter Schmalfeldt` ( or other project administrator ) | ||
| 5. Choose an appropriate label from the `Labels` | ||
| > Each New Feature should reside in its own `feature/` branch. The branch name should be formatted `feature/###-feature-name` where `###` is the GitHub Issue Number, and `feature-name` is a 1-3 word summary of the feature. | ||
| Now you can submit a new PR using the Prepopulated Template that we provide. PR's submitted that do not use the template will be rejected. | ||
| 1. Checkout latest `develop` branch | ||
| 2. Pull down the latest changes via `git pull` | ||
| 3. Create a new branch with the structure `feature/*`, e.g. `feature/123-mobile-header` | ||
| 4. When you are ready to submit your code, submit a new Pull Request that merges your code into `develop` | ||
| 5. Tag your new Pull Request with `Ready for Code Review` |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| name: Bug Report | ||
| description: I would like to Report a Bug | ||
| labels: [Bug Report] | ||
| assignees: | ||
| - manifestinteractive | ||
| body: | ||
| - type: checkboxes | ||
| attributes: | ||
| label: Is there an existing issue for this? | ||
| description: Please search to see if an issue already exists for the bug you encountered. | ||
| options: | ||
| - label: I have searched the existing issues | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Describe the Bug | ||
| description: A clear and concise description of what the bug is. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Steps To Reproduce | ||
| description: Steps to reproduce the behavior. | ||
| placeholder: | | ||
| 1. Go to ... | ||
| 2. Click on ... | ||
| 3. Scroll down to ... | ||
| 4. See error ... | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Expected Behavior | ||
| description: A concise description of what you expected to happen. | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| attributes: | ||
| label: Screenshots | ||
| description: If applicable, add screenshots to help explain your problem. | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| attributes: | ||
| label: Environment | ||
| description: | | ||
| examples: | ||
| - **OS**: Ubuntu 20.04 | ||
| - **Node**: 13.14.0 | ||
| - **npm**: 7.6.3 | ||
| value: | | ||
| - OS: | ||
| - Node: | ||
| - npm: | ||
| render: markdown | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| attributes: | ||
| label: Additional Context | ||
| description: | | ||
| Links? References? Anything that will give us more context about the issue you are encountering! | ||
| Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. | ||
| validations: | ||
| required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| name: Feature Request | ||
| description: This is a new Feature Request for this project | ||
| labels: [Feature Request] | ||
| assignees: | ||
| - manifestinteractive | ||
| body: | ||
| - type: textarea | ||
| attributes: | ||
| label: Describe the Problem | ||
| description: Is your feature request related to a problem? Please describe. | ||
| placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Describe the Solution | ||
| description: Describe the solution you'd like | ||
| placeholder: A clear and concise description of what you want to happen. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Alternatives | ||
| description: Describe alternatives you've considered | ||
| placeholder: A clear and concise description of any alternative solutions or features you've considered. | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| attributes: | ||
| label: Additional Context | ||
| description: | | ||
| Add any other context or screenshots about the feature request here. | ||
| Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. | ||
| validations: | ||
| required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| name: Question | ||
| description: I have a Question about this project | ||
| labels: [Question] | ||
| assignees: | ||
| - manifestinteractive | ||
| body: | ||
| - type: textarea | ||
| attributes: | ||
| label: Question | ||
| description: Please Write your Question Below. | ||
| validations: | ||
| required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| name: Requested Change | ||
| description: This is a Requested Change to the project | ||
| labels: [Requested Change] | ||
| assignees: | ||
| - manifestinteractive | ||
| body: | ||
| - type: textarea | ||
| attributes: | ||
| label: Describe the Problem | ||
| description: Is your requested change related to a problem? Please describe. | ||
| placeholder: A clear and concise description of what the request is. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Describe the Solution | ||
| description: Describe the solution you'd like | ||
| placeholder: A clear and concise description of what you want to happen. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Alternatives | ||
| description: Describe alternatives you've considered | ||
| placeholder: A clear and concise description of any alternative solutions or features you've considered. | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| attributes: | ||
| label: Additional Context | ||
| description: | | ||
| Add any other context or screenshots about the feature request here. | ||
| Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. | ||
| validations: | ||
| required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,33 +1,31 @@ | ||
| #### What's this PR do? | ||
| Overview | ||
| --- | ||
|
|
||
| _[write_something]_ | ||
| TEXT | ||
|
|
||
| #### Where should the reviewer start? | ||
| Reviewer | ||
| --- | ||
|
|
||
| _[write_something]_ | ||
| > Where should the reviewer start? How to Test? Background Context? etc ( required ) | ||
| #### How should this be manually tested? | ||
| TEXT | ||
|
|
||
| _[write_something]_ | ||
| Checklist | ||
| --- | ||
|
|
||
| #### Any background context you want to provide? | ||
| > I have tested each of the following, and they work as expected: ( required ) | ||
| _[write_something]_ | ||
| - [ ] Meets [Contributing Guide](https://github.com/sfccdevops/sfcc-devtools/blob/develop/.github/CONTRIBUTING.md) Requirements | ||
| - [ ] Pulled in the Latest Code from the `develop` branch | ||
| - [ ] Works on a Desktop / Laptop Device | ||
|
|
||
| #### What are the relevant github issue? | ||
| Documentation | ||
| --- | ||
|
|
||
| _[write_something]_ | ||
| > Screenshots, Attachments, Linked GitHub Issues, etc ( optional ) | ||
| #### Screenshots (if appropriate) | ||
|
|
||
| _[drag_and_drop_here]_ | ||
|
|
||
| #### What gif best describes this PR or how it makes you feel? | ||
| #### What GIF best describes this PR or how it makes you feel? | ||
|
|
||
| _[drag_and_drop_something_fun_here]_ | ||
|
|
||
| #### Definition of Done: | ||
|
|
||
| - [ ] You have actually run this locally and can verify it works | ||
| - [ ] You have verified that `npm test` passes without issue | ||
| - [ ] You have updated the README file (if appropriate) | ||
| > Drag & Drop Something Fun Here ( optional ) |
Oops, something went wrong.