From b64d11ec02f2633b28297877548b50cdd040ee27 Mon Sep 17 00:00:00 2001 From: bitpredator <67551273+bitpredator@users.noreply.github.com> Date: Mon, 25 Dec 2023 15:24:29 +0100 Subject: [PATCH 1/2] feat: .github\Contributing.md --- .github/Contributing.md | 45 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 .github/Contributing.md diff --git a/.github/Contributing.md b/.github/Contributing.md new file mode 100644 index 00000000..9c02297a --- /dev/null +++ b/.github/Contributing.md @@ -0,0 +1,45 @@ +# Welcome + +Welcome to the "Italian-Truck-Company" project repository. Thank you for your interest in contributing to the project. Full details and guidelines on how to ensure this project is managed well are included below. + +## Contributing to the project + +As this is an open source project, anyone is free to contribute as much or as little as they like. If you're just getting started with GitHub or project contributions then we suggest you take a look at issues on the repository. These issues will vary in complexity depending on the issue itself. + +If you're comfortable contributing to Open Source projects on GitHub please ensure you read our expectations for issue tracking, feature proposals and pull requests. + +## Testing the project + +If changes are made they should always be tested to make sure they work as intended and don't conflict with other systems. If you see a pull request open it's recommended that you test the features that were implemented to check for errors or it works as intended. + +## Issue Tracking +Please use GitHub issues to track new features or bugs. + +When submitting an issue, there's a few guidelines we'd ask you to respect to make it easier to manage and for others to understand: +* **Search the issue tracker** before you submit your issue - it may already be present. +* When opening an issue, a template is provided for you. Please provide as much information as requested to ensure others are able to act upon the requests or bug report. +* Please ensure you add screenshots or documentation references for bugs/changes so we can quickly ascertain if the request is suitable. + +**In order to be 'assigned' an issue**, please comment on the issue itself letting others know you are working on it. + +## Pull Requests + +We welcome pull requests with fixes and improvements to the project. + +The work-flow for submitting a new pull request is designed to be simple, but also to ensure consistency from **all** contributors: +* Fork the project into your personal space on GitHub.com. +* Add changes to CHANGELOG.md with credits to yourself. +* Commit your changes. +* When writing commit messages make sure they are clear about what has been changed. +* Push the commit(s) to your fork. +* Submit a pull request (PR) to the master branch. +* The PR title should describe the change that has been made. +* Follow the PR template and write as much detail as necessary for your changes and include documents/screenshots if needed. +* Be prepared to answer any questions about your PR when it is reviewed for acceptance. + +**Please** keep your changes in a single PR as small as possible (relating to one issue) as this makes it easier to review and accept. Large PRs with a small error will prevent the entire PR from being accepted. + +## Expectations +As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, issues and other contributions that are not aligned to this Code of Conduct. \ No newline at end of file From 1d3d0ae7fe27cc0947458e32e24c97c34ea40ed3 Mon Sep 17 00:00:00 2001 From: bitpredator <67551273+bitpredator@users.noreply.github.com> Date: Mon, 25 Dec 2023 15:24:43 +0100 Subject: [PATCH 2/2] feat: .github\workflows\test-deploy.yml --- .github/workflows/test-deploy.yml | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 .github/workflows/test-deploy.yml diff --git a/.github/workflows/test-deploy.yml b/.github/workflows/test-deploy.yml new file mode 100644 index 00000000..b7e9a873 --- /dev/null +++ b/.github/workflows/test-deploy.yml @@ -0,0 +1,24 @@ +name: Test deployment + +on: + pull_request: + branches: + - main + # Review gh actions docs if you want to further define triggers, paths, etc + # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on + +jobs: + test-deploy: + name: Test deployment + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-node@v3 + with: + node-version: 18 + cache: yarn + + - name: Install dependencies + run: yarn install --frozen-lockfile + - name: Test build website + run: yarn build \ No newline at end of file