diff --git a/.github/workflows/pull-requests.yaml b/.github/workflows/pull-requests.yaml index c2c3771..bd77792 100644 --- a/.github/workflows/pull-requests.yaml +++ b/.github/workflows/pull-requests.yaml @@ -8,7 +8,7 @@ jobs: strategy: fail-fast: false matrix: - cmd: ["format:check", "lint:check", "build"] + cmd: ["format:check", "lint:check"] runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 @@ -40,9 +40,3 @@ jobs: - name: "Running ${{ matrix.cmd }}" run: npm run ${{ matrix.cmd }} continue-on-error: ${{ matrix.cmd == 'lint:check' }} - - - name: Annotate Code Linting Results - if: ${{ matrix.cmd == 'lint:check' }} - uses: ataylorme/eslint-annotate-action@v3 - with: - report-json: "eslint_report.json" diff --git a/.gitignore b/.gitignore index f6d01fd..ebbf247 100644 --- a/.gitignore +++ b/.gitignore @@ -21,6 +21,13 @@ dist # temporary reports eslint_report.json +# ignore the log files +storage/**/*.log + +# ignore all transpiled files +packages/**/*.d.ts +packages/**/*.js + #yarn .pnp.* .yarn/* diff --git a/.husky/commit-msg b/.husky/commit-msg new file mode 100644 index 0000000..0a4b97d --- /dev/null +++ b/.husky/commit-msg @@ -0,0 +1 @@ +npx --no -- commitlint --edit $1 diff --git a/.husky/pre-commit b/.husky/pre-commit new file mode 100644 index 0000000..d6cb288 --- /dev/null +++ b/.husky/pre-commit @@ -0,0 +1 @@ +npm run build diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b25a0b6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,315 @@ +# Contributing to Intent + +We would love for you to contribute to Intent and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow: + + + +- [Question or Problem?](#question) +- [Issues and Bugs](#issue) +- [Feature Requests](#feature) +- [Submission Guidelines](#submit) +- [Development Setup](#development) +- [Coding Rules](#rules) +- [Commit Message Guidelines](#commit) + + + + +## Got a Question or Problem? + +**Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests.** You've got much better chances of getting your questions answered on [Stack Overflow][stackoverflow] where the questions should be tagged with tag `intentjs`. + +Stack Overflow is a much better place to ask questions since: + + + +- questions and answers stay available for public viewing so your question / answer might help someone else +- Stack Overflow's voting system assures that the best answers are prominently visible. + +To save your and our time, we will systematically close all issues that are requests for general support and redirect people to Stack Overflow. + +If you would like to chat about the question in real-time, you can reach out via [our discord channel][https://discord.gg/5ambDUN7Ge]. + +## Found a Bug? + +If you find a bug in the source code, you can help us by +[submitting an issue](#submit-issue) to our [GitHub Repository][github]. Even better, you can +[submit a Pull Request](#submit-pr) with a fix. + +## Missing a Feature? + +You can _request_ a new feature by [submitting an issue](#submit-issue) to our GitHub +Repository. If you would like to _implement_ a new feature, please submit an issue with +a proposal for your work first, to be sure that we can use it. +Please consider what kind of change it is: + +- For a **Major Feature**, first open an issue and outline your proposal so that it can be + discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, + and help you to craft the change so that it is successfully accepted into the project. For your issue name, please prefix your proposal with `[discussion]`, for example "[discussion]: your feature idea". +- **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr). + +## Submission Guidelines + +### Submitting an Issue + +Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available. + +We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs we will systematically ask you to provide a minimal reproduction scenario using a repository or [Gist](https://gist.github.com/). Having a live, reproducible scenario gives us wealth of important information without going back & forth to you with additional questions like: + +- version of Intent used +- 3rd-party libraries and their versions +- and most importantly - a use-case that fails + +Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you we are going to close an issue that doesn't have enough info to be reproduced. + +You can file new issues by filling out our [new issue form][new_issue]. + +### Submitting a Pull Request (PR) + +Before you submit your Pull Request (PR) consider the following guidelines: + + + +1. Search [GitHub Pull Requests][gh_prs] for an open or closed PR + that relates to your submission. You don't want to duplicate effort. +1. Fork this repository. +1. Make your changes in a new git branch: + + ```shell + git checkout -b my-fix-branch main + ``` + +1. Create your patch, **including appropriate test cases**. +1. Follow our [Coding Rules](#rules). +1. Commit your changes using a descriptive commit message that follows our + [commit message conventions](#commit). Adherence to these conventions + is necessary because release notes are automatically generated from these messages. + + ```shell + git commit -a + ``` + + Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files. + +1. Push your branch to GitHub: + + ```shell + git push origin my-fix-branch + ``` + +1. In GitHub, send a pull request to `intent:main`. + +- If we suggest changes then: + + - Make the required updates. + - Rebase your branch and force push to your GitHub repository (this will update your Pull Request): + + ```shell + git rebase main -i + git push -f + ``` + +That's it! Thank you for your contribution! + +#### After your pull request is merged + +After your pull request is merged, you can safely delete your branch and pull the changes +from the main (upstream) repository: + +- Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows: + + ```shell + git push origin --delete my-fix-branch + ``` + +- Check out the main branch: + + ```shell + git checkout main -f + ``` + +- Delete the local branch: + + ```shell + git branch -D my-fix-branch + ``` + +- Update your main with the latest upstream version: + + ```shell + git pull --ff upstream main + ``` + +## Development Setup + +You will need [Node.js](https://nodejs.org) version >= 20.15.0. + +1. After cloning the repo, run: + +```bash +$ npm install +``` + +2. In order to prepare the `integrations/sample-app`, run the `setup.sh` shell script. + +```bash +$ sh scripts/setup.sh +``` + +This will initialise some necessary files, run a build, link the binaries. + +3. Now get the project running using the `npm run dev` command. + +```bash +$ npm run dev +``` + +### Commonly used NPM scripts + +```bash +# run the integration apps and packages locally +$ npm run dev + +# Build the project +npm run build + +# run the full unit tests suite +$ npm run test + +# run linter +$ npm run lint +``` + +## Coding Rules + +To ensure consistency throughout the source code, keep these rules in mind as you are working: + + + +- All features or bug fixes **must be tested** by one or more specs (unit-tests). +- We follow [Google's JavaScript Style Guide][js-style-guide], but wrap all code at + **100 characters**. An automated formatter is available (`npm run format`). + +## Commit Message Guidelines + +We have very precise rules over how our git commit messages can be formatted. This leads to **more readable messages** that are easy to follow when looking through the **project history**. But also, we use the git commit messages to **generate the Intent change log**. + +### Commit Message Format + +Each commit message consists of a **header**, a **body** and a **footer**. The header has a special +format that includes a **type**, a **scope** and a **subject**: + +``` +(): + + + +