generated from boozt-platform/quickstart-template
-
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.
- Loading branch information
0 parents
commit 2894d45
Showing
10 changed files
with
406 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
<!-- | ||
SPDX-FileCopyrightText: Copyright Boozt Fashion, AB | ||
SPDX-License-Identifier: MIT | ||
--> | ||
|
||
<!-- You may remove the content below, but keep only the related stuff. --> | ||
|
||
<!-- Appreciation and Introduction --> | ||
Thank you for taking the time to submit an issue! Your contribution is valuable to us. Before you proceed, please take a moment to go through the checklist below: | ||
|
||
### Checklist | ||
|
||
- [ ] Have you attempted to debug or fix the issue yourself? Bug fixes and documentation improvements are always welcome. | ||
- [ ] Have you checked if a similar issue has already been created? | ||
- [ ] Do you have an idea for a new feature? If so, please label your issue with "enhancement". | ||
|
||
<!-- Bug Report --> | ||
If none of the above apply, you may proceed to create a new bug report. Please provide the following information to help us address the issue effectively: | ||
|
||
### Bug Report Details | ||
|
||
- **Description**: Describe the issue in detail. | ||
- **Steps to Reproduce**: Provide a clear and concise description of the steps to reproduce the issue. | ||
- **Expected Behavior**: Describe what you expected to happen. | ||
- **Actual Behavior**: Describe what actually happened. | ||
- **Version**: Specify the version of the software you are using. | ||
- **Operating System**: Specify the OS and version you are using (e.g., Mac, Linux, Windows). | ||
- **Labels**: Use `bug` and `help wanted`. | ||
|
||
<!-- Additional Information (if applicable) --> | ||
Feel free to include any additional information such as code snippets, links, screenshots, or any other relevant facts that may help in diagnosing and resolving the issue. | ||
|
||
Thank you for your contribution to our project! |
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,29 @@ | ||
<!-- | ||
SPDX-FileCopyrightText: Copyright Boozt Fashion, AB | ||
SPDX-License-Identifier: MIT | ||
--> | ||
|
||
<!-- You may remove the content below, but keep only the related stuff. --> | ||
|
||
<!-- Appreciation and Reminder --> | ||
Thank you for your pull request! Before proceeding, please take a moment to search among existing pull requests to ensure that a similar one hasn't already been opened. | ||
|
||
### Pull Request Details | ||
|
||
Please provide enough information to facilitate the review process: | ||
|
||
- **Description**: Briefly describe the changes made in this pull request. | ||
- **Contributing Guidelines**: Please review the CONTRIBUTING file for guidelines on contributing to this project. | ||
- **Commit Messages**: Ensure that your commit messages follow the conventional commits guidelines. | ||
- **Documentation**: Double-check if any documentation needs to be updated within your changes. | ||
- **Tests**: Have tests been added to cover the changes made? | ||
- **Type of Change**: What kind of change does this PR introduce? (Bug fix, feature, docs update, etc.) | ||
- **Current Behavior**: Describe the current behavior, or link to an open issue if applicable. | ||
- **New Behavior**: Describe the new behavior introduced by this PR, especially if it's a feature change. | ||
- **Breaking Changes**: Does this PR introduce any breaking changes? If so, provide guidelines to support backward compatibility and inform users how to resolve potential issues. | ||
|
||
### Additional Information | ||
|
||
Please provide any additional information or context that may be relevant to this pull request. | ||
|
||
Thank you for your contribution to our project! |
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,23 @@ | ||
# SPDX-FileCopyrightText: Copyright Boozt Fashion, AB | ||
# SPDX-License-Identifier: MIT | ||
|
||
name: Release | ||
on: | ||
push: | ||
branches: | ||
- 'main' | ||
jobs: | ||
release: | ||
runs-on: ubuntu-latest | ||
permissions: | ||
contents: write | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- uses: actions/setup-go@v3 | ||
with: | ||
go-version: 1.19 | ||
- uses: go-semantic-release/action@v1 | ||
with: | ||
hooks: goreleaser | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
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 @@ | ||
# SPDX-FileCopyrightText: Copyright Boozt Fashion, AB | ||
# SPDX-License-Identifier: MIT | ||
|
||
# For more information about the configuration file, see: | ||
# https://goreleaser.com/customization/build/ | ||
|
||
builds: | ||
# By default we don't let to release packages. Our consideration is to use SemVer | ||
# based by conventional commits to release new versions of the project once it's | ||
# merged to the main branch. If this is a Go project, you can remove this section | ||
# and use the default configuration to release the packages within the new version. | ||
- skip: 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,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2024 Boozt Platform | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
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,81 @@ | ||
<!-- Header Starts --> | ||
[<img src="https://raw.githubusercontent.com/boozt-platform/branding/main/assets/img/platform-logo.png" width="350"/>][homepage] | ||
|
||
[![GitHub Tag (latest SemVer)](https://img.shields.io/github/v/tag/boozt-platform/quickstart-template.svg?label=latest&sort=semver)][releases] | ||
[![license](https://img.shields.io/badge/license-mit-brightgreen.svg)][license] | ||
|
||
<!-- Title & Description --> | ||
# quickstart-template | ||
|
||
Quickstart template for GitHub repositories. You may use this template to create new repositories with a predefined structure. | ||
<!-- Header Ends --> | ||
|
||
<!-- TOC Starts --> | ||
## Table of Contents | ||
|
||
- [How to Use It](#how-to-use-it) | ||
- [About Boozt](#about-boozt) | ||
- [Reporting Issues](#reporting-issues) | ||
- [Contributing](#contributing) | ||
- [License](#license) | ||
<!-- TOC Ends --> | ||
|
||
<!-- Body Starts --> | ||
## How to Use It | ||
|
||
This project is a template repository with various guidelines, the required CI release versioning pipeline, licenses, and more. You may use this project as a reference to start a new repository. Once you've created a new repository from this template, update the `README.md` file content according to your needs. | ||
|
||
It is necessary to maintain consistency and structure in this `README.md` file. Please follow the action items below and the comment blocks of this file (`<!-- comment block -->`): | ||
|
||
- [x] Create repository from this quickstart template. | ||
- [ ] Update Title & Description | ||
- [ ] Add extra header badges if needed. Please keep the License, SemVer badges, and Logo image the same as they were distributed within this file. | ||
- [ ] Update body content according to your project. | ||
- [ ] Update the Table of Contents (TOC) based on your updated body content. | ||
- [ ] Please keep the footer the same as it was distributed within this file. | ||
- [ ] Remove all comment blocks from this `README.md` file i.e. `<!-- Body Starts--> <!-- Any other comment block -->`. | ||
- [ ] Remove this [How to Use It](#how-to-use-it) section. | ||
- [ ] Update [docs/CODEOWNERS](docs/CODEOWNERS) file. | ||
- [ ] Update [.goreleaser.yaml](.goreleaser.yaml) to your needs, this file and CI pipeline [.github/workflows/release.yml](.github/workflows/release.yml) are used to release new versions automatically once the PRs are merged to the main branch. | ||
<!-- Body Ends --> | ||
|
||
<!-- Footer Starts --> | ||
## About Boozt | ||
|
||
Boozt is a leading and fast-growing Nordic technology company selling fashion and lifestyle online mainly through its multi-brand webstore [Boozt.com][boozt] and [Booztlet.com][booztlet]. | ||
|
||
The company is focused on using cutting-edge, in-house developed technology to curate the best possible customer experience. | ||
|
||
With offices in Sweden, Denmark, Lithuania and Poland, we pride ourselves in having a diverse team, consisting of 1100+ employees and 38 nationalities. | ||
|
||
See our [Medium][blog] blog page for technology-focused articles. Would you like to make your mark by working with us at Boozt? Take a look at our [latest hiring opportunities][careers]. | ||
|
||
## Reporting Issues | ||
|
||
Please provide a clear and concise description of the problem or the feature you're missing along with any relevant context or screenshots. | ||
|
||
Check existing issues before reporting to avoid duplicates. | ||
|
||
Please follow the [Issue Reporting Guidelines][issues] before opening a new issue. | ||
|
||
## Contributing | ||
|
||
Contributions are highly valued and very welcome! For the process of reviewing changes, we use [Pull Requests][pull-request]. For a detailed information please follow the [Contribution Guidelines][contributing] | ||
|
||
## License | ||
|
||
[![license](https://img.shields.io/badge/license-mit-brightgreen.svg)][license] | ||
|
||
This project is licensed under the MIT. Please see [LICENSE][license] for full details. | ||
|
||
[homepage]: https://github.com/boozt-platform/quickstart-template | ||
[releases]: https://github.com/boozt-platform/quickstart-template/releases | ||
[issues]: https://github.com/boozt-platform/quickstart-template/issues | ||
[pull-request]: https://github.com/boozt-platform/quickstart-template/pulls | ||
[contributing]: ./docs/CONTRIBUTING.md | ||
[license]: ./LICENSE | ||
[boozt]: https://www.boozt.com/ | ||
[booztlet]: https://www.booztlet.com/ | ||
[blog]: https://medium.com/boozt-tech | ||
[careers]: https://careers.booztgroup.com/ | ||
<!-- Footer Ends --> |
Validating CODEOWNERS rules …
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,13 @@ | ||
# docs documentation | ||
/docs/CODE_OF_CONDUCT.md @boozt-platform/owners | ||
/docs/CODEOWNERS.md @boozt-platform/owners | ||
/docs/CONTRIBUTING.md @boozt-platform/owners | ||
/docs/SECURITY.md @boozt-platform/owners | ||
|
||
# .github documentation | ||
/.github/issue_template.md @boozt-platform/contributors | ||
/.github/pull_request_template.md @boozt-platform/contributors | ||
|
||
# CI | ||
/.github/workflows/release.yml @boozt-platform/owners | ||
/.goreleaser.yaml @boozt-platform/owners |
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,79 @@ | ||
<!-- | ||
SPDX-FileCopyrightText: Copyright Boozt Fashion, AB | ||
SPDX-License-Identifier: MIT | ||
--> | ||
|
||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to make 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 includes 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 [email protected], which is a shared team inbox. If the incident involves someone who receives that shared inbox, you can contact an individual maintainer (@doniz) at ```donnav``` + ```@boozt.com```. 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://contributor-covenant.org/version/1/4][version] | ||
|
||
[homepage]: https://contributor-covenant.org | ||
[version]: https://contributor-covenant.org/version/1/4/ |
Oops, something went wrong.