-
Notifications
You must be signed in to change notification settings - Fork 14
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
Showing
6 changed files
with
4,356 additions
and
102 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,8 @@ | ||
# Changesets | ||
|
||
Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works | ||
with multi-package repos, or single-package repos to help you version and publish your code. You can | ||
find the full documentation for it [in our repository](https://github.com/changesets/changesets) | ||
|
||
We have a quick list of common questions to get you started engaging with this project in | ||
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md) |
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 @@ | ||
{ | ||
"$schema": "https://unpkg.com/@changesets/config@3.0.0/schema.json", | ||
"changelog": ["@changesets/cli/changelog", { "repo": "FlowTestAi/FlowTest" }], | ||
"commit": false, | ||
"fixed": [], | ||
"linked": [], | ||
"access": "public", | ||
"baseBranch": "main", | ||
"updateInternalDependencies": "patch", | ||
"ignore": [], | ||
"changedFilePatterns": ["src/**/"] | ||
} |
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,91 @@ | ||
# Contribution Guidelines | ||
|
||
When contributing to `FlowTestAI`, whether on GitHub or in other community spaces: | ||
|
||
- Be respectful, civil, and open-minded. | ||
- Before opening a new pull request, try searching through the [issue tracker](https://github.com/FlowTestAI/FlowTest/issues) for known issues or fixes. | ||
- If you want to make code changes based on your personal opinion(s), make sure you open an issue first describing the changes you want to make, and open a pull request only when your suggestions get approved by maintainers. | ||
|
||
## How to Contribute | ||
|
||
### Prerequisites | ||
|
||
In order to not waste your time implementing a change that has already been declined, or is generally not needed, start by [opening an issue](https://github.com/FlowTestAI/FlowTest/issues/new/choose) describing the problem you would like to solve. | ||
|
||
### Setup your environment locally | ||
|
||
_Some commands will assume you have the Github CLI installed, if you haven't, consider [installing it](https://github.com/cli/cli#installation), but you can always use the Web UI if you prefer that instead._ | ||
|
||
In order to contribute to this project, you will need to fork the repository: | ||
|
||
```bash | ||
gh repo fork FlowTestAI/FlowTest | ||
``` | ||
|
||
then, clone it to your local machine: | ||
|
||
```bash | ||
gh repo clone <your-github-name>/FlowTest | ||
``` | ||
|
||
This project uses [pnpm](https://pnpm.io) as its package manager. Install it if you haven't already: | ||
|
||
```bash | ||
npm install -g pnpm@9.0.6 | ||
``` | ||
|
||
Then, install the project's dependencies: | ||
|
||
```bash | ||
pnpm install | ||
``` | ||
|
||
### Implement your changes | ||
|
||
This project is a monorepo. The code for the CLI is in the `package/flowtest-cli` directory, (add here learn what flowtest-electron is vs the main src folder) | ||
|
||
Here are some useful scripts for when you are developing: | ||
|
||
| Command | Description | | ||
| ---------------- | ------------------------------------------------------- | | ||
| `pnpm start` | Builds and starts the FlowTest App on your desktop | | ||
| `pnpm build` | Builds the application for development use | | ||
| `pnpm format` | Formats the code | | ||
| `pnpm lint` | Lints the code | | ||
| `pnpm lint:fix` | Lints the code and fixes any errors | | ||
| `pnpm clean` | Deletes all node_modules in the project| | ||
|
||
When making commits, make sure to follow the [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) guidelines, i.e. prepending the message with `feat:`, `fix:`, `chore:`, `docs:`, etc... You can use `git status` to double check which files have not yet been staged for commit: | ||
|
||
```bash | ||
git add <file> && git commit -m "feat/fix/chore/docs: commit message" | ||
``` | ||
|
||
### When you're done | ||
|
||
Please make a manual, functional test of your changes. | ||
|
||
If your change should appear in the changelog, i.e. it changes some behavior of either the CLI or the outputted application, it must be captured by `changeset` which is done by running | ||
|
||
```bash | ||
pnpm changeset | ||
``` | ||
|
||
and filling out the form with the appropriate information. Then, add the generated changeset to git: | ||
|
||
```bash | ||
git add .changeset/*.md && git commit -m "chore: add changeset" | ||
``` | ||
|
||
When all that's done, it's time to file a pull request to upstream: | ||
|
||
```bash | ||
gh pr create --web | ||
``` | ||
|
||
and fill out the title and body appropriately. Again, make sure to follow the [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) guidelines for your title. | ||
|
||
|
||
## Credits | ||
|
||
This documented was inspired by the contributing guidelines for [t3-oss/create-t3-app](https://github.com/t3-oss/create-t3-app/blob/main/CONTRIBUTING.md). |
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
Oops, something went wrong.