Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: making the repository in the standard #3

Open
wants to merge 21 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"projectName": "sylius",
"projectOwner": "vuestorefront",
"repoType": "github",
"repoHost": "https://github.com",
"files": [
"README.md"
],
"imageSize": 80,
"commit": true,
"commitConvention": "angular",
"contributors": [
{
"login": "bloodf",
"name": "Heitor Ramon Ribeiro",
"avatar_url": "https://avatars.githubusercontent.com/u/1626923?v=4",
"profile": "https://github.com/bloodf",
"contributions": [
"maintenance",
"projectManagement"
]
}
],
"contributorsPerLine": 5
}
7 changes: 7 additions & 0 deletions .czrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"path": "cz-conventional-changelog",
"disableScopeLowerCase": false,
"disableSubjectLowerCase": false,
"maxHeaderWidth": 100,
"maxLineWidth": 100
}
50 changes: 50 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Contributing to @vuestorefront-community/sylius
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer

## We Develop with Github
We use github to host code, to track issues and feature requests, as well as accept pull requests.

## We Use [Git Flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow), So All Code Changes Happen Through Pull Requests
Pull requests are the best way to propose changes to the codebase (we use [Git Flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)). We actively welcome your pull requests:

1. Fork the repo and create your branch from `develop`.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints.
6. Issue that pull request!

## Any contributions you make will be under the MIT Software License
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.

## Report bugs using Github's [issues](https://github.com/vuestorefront-community/sylius/issues)
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/vuestorefront-community/sylius/issues/new); it's that easy!

## Write bug reports with detail, background, and sample code
**Great Bug Reports** tend to have:

- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can.
- What you expected would happen
- What actually happens
- The environment you're running the application
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People *love* thorough bug reports. I'm not even kidding.

## Use a Consistent Coding Style
I'm again borrowing these from [AirBnB's Code Style](https://github.com/airbnb/javascript)

* 2 spaces for indentation rather than tabs
* You can try running `npm run lint` for style unification

## License
By contributing, you agree that your contributions will be licensed under its MIT License.
50 changes: 23 additions & 27 deletions .github/ISSUE_TEMPLATE/1.bug-report.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
name: "🐛 Bug report"
description: |
Create a report to help us improve
description: Report errors or unexpected behavior
labels:
- bug
- triage-needed
Expand All @@ -9,34 +8,41 @@ body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report, please make sure to [search for existing issues](https://github.com/vuestorefront/vue-storefront/issues) before filing a new one!
Thanks for taking the time to fill out this bug report, please make sure to [search for existing issues](https://github.com/vuestorefront-community/sylius/issues) before filing a new one!
- type: textarea
id: whattoexpect
attributes:
label: Describe the Bug
description: Can you provide a clear and concise description of the bug
label: Expected Behavior
placeholder: What were you expecting?
validations:
required: true
required: false
- type: textarea
id: currentbehavior
id: whathappened
attributes:
label: Current behavior
placeholder: Describe the current behavior pointing exactly why it's not working as intended
label: Actual Behavior
placeholder: What happened instead??
validations:
required: true
- type: textarea
id: expectedbehavior
id: solution
attributes:
label: Expected behavior
placeholder: Describe what the desired behavior should be
label: Possible Solution
description: Also, if possible provide the information on how to implement the solution.
placeholder: Do you have any possible solution or fix for this bug?
validations:
required: true
required: false
- type: textarea
id: reproduce
attributes:
label: Steps to reproduce
placeholder: Please provide the steps to reproduce and if possible a minimal reproducible example of the problem
description: Please provide detailed instructions on how to reproduce.
placeholder: How we can reproduce this bug?
validations:
required: false
- type: input
attributes:
label: What version of Vue Storefront are you using?
description: 'For example: 2.3.4'
label: What version of Sylius integration are you using?
description: 'For example: 1.0.0'
validations:
required: true
- type: input
Expand All @@ -63,21 +69,11 @@ body:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: checkboxes
id: fixthebug
attributes:
label: Able to fix / change the documentation?
description: Can you handle this change and create a Pull Request?
options:
- label: 'Yes'
required: false
- label: 'No'
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/vuestorefront/vue-storefront/blob/master/CODE_OF_CONDUCT.md)
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/vuestorefront-community/sylius/blob/master/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/2.documentation-issue.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ body:
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/vuestorefront/vue-storefront/blob/master/CODE_OF_CONDUCT.md)
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/vuestorefront-community/sylius/blob/master/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
8 changes: 1 addition & 7 deletions .github/ISSUE_TEMPLATE/3.feature-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,11 @@ body:
attributes:
label: Additional information
description: If you think that any additional information would be useful please provide them here.
- type: input
attributes:
label: What version of Vue Storefront this feature can be implemented?
description: 'For example: 2.3.4'
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/vuestorefront/vue-storefront/blob/master/CODE_OF_CONDUCT.md)
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/vuestorefront-community/sylius/blob/master/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/4.question.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ body:
required: true
- type: input
attributes:
label: What version of Vue Storefront are you using?
description: 'For example: 2.3.4'
label: What version of Sylius Integration are you using?
description: 'For example: 1.0.0'
validations:
required: true
- type: checkboxes
Expand Down
3 changes: 0 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Documentation
url: https://docs.vuestorefront.io/
about: Find more information about the project and how to implement in our documentation.
- name: Discord Chat
url: https://discord.vuestorefront.io/
about: Ask questions and discuss with other Vue Storefront users in real time.
31 changes: 5 additions & 26 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
<!--- Provide a general summary of your changes in the Title above -->

## Description
<!-- describe in a few words what is this Pull Request changing and why it's useful -->
<!--- Describe your changes in detail -->

## Related Issue
<!--- This project only accepts pull requests related to open issues -->
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
<!--- For example closes #123 -->
<!--- Please link to the issue here: -->

## Motivation and Context
Expand All @@ -18,8 +17,7 @@
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->

## Screenshots:
<!-- if appropriate, and if you made any changes in the UI layer please provide before/after screenshots -->
## Screenshots (if appropriate):

## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
Expand All @@ -30,28 +28,9 @@
## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] I have read the **CONTRIBUTING** document.

#### Changelog
- [ ] I have updated the Changelog ([V1](https://github.com/DivanteLtd/vue-storefront/blob/develop/CHANGELOG.md)) [v2](https://docs-next.vuestorefront.io/contributing/creating-changelog.html) and mentioned all breaking changes in the public API.
- [ ] I have documented all new public APIs and made changes to existing docs mentioning the parts I've changed so they're up to date.

#### Tests
- [ ] I have written test cases for my code
- [ ] I have tested my Pull Request on production build and (to my knowledge) it works without any issues
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.
<!-- VSF 1 only -->
> I tested manually my code, and it works well with both:
- [ ] Default Theme
- [ ] Capybara Theme

#### Code standards
- [ ] My code follows the code style of this project.
<!-- VSF 2 only -->
- [ ] I have followed [naming conventions](https://github.com/kettanaito/naming-cheatsheet)

#### Docs
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.

- [ ] I have read the **CONTRIBUTING** document.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.
9 changes: 9 additions & 0 deletions .github/lock.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Configuration for lock-threads - https://github.com/dessant/lock-threads
# disable lock bot for now
daysUntilLock: 3650
exemptLabels: []
lockLabel: false
lockComment: >
This thread has been automatically locked since there has not been
any recent activity after it was closed. Please open a new issue for
related bugs.
18 changes: 18 additions & 0 deletions .github/workflows/assing-pr-to-author.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: PR to Author
on:
pull_request:
types: [opened, ready_for_review, edited, synchronize]

concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
cancel-in-progress: true

jobs:
assignAuthor:
name: Assing
runs-on: ubuntu-latest
steps:
- uses: samspills/assign-pr-to-author@v1.0
if: github.event_name == 'pull_request' && github.event.action == 'opened'
with:
repo-token: '${{ secrets.GITHUB_TOKEN }}'
17 changes: 14 additions & 3 deletions .github/workflows/conventional-pr-name.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,23 @@ on:
pull_request:
types: ['opened', 'edited', 'reopened', 'synchronize']

concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
cancel-in-progress: true

jobs:
lint:
name: Validate PR Title (conventional-commit)
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v1

- name: Setup node
uses: actions/setup-node@v2
with:
node-version: "16"

- name: Install Dependencies
run: npm install @commitlint/config-conventional
- uses: JulienKode/pull-request-name-linter-action@v0.1.2
run: yarn

- uses: JulienKode/pull-request-name-linter-action@v0.2.0
Loading