https://github.com/effect-ts/monorepo-testing
https://github.com/effect-ts/monorepo-testing
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/effect-ts/monorepo-testing
- Owner: Effect-TS
- License: mit
- Created: 2023-10-19T02:33:27.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-14T10:30:21.000Z (over 2 years ago)
- Last Synced: 2025-02-22T11:43:52.495Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 19.8 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Effect
Welcome to Effect, a powerful TypeScript framework that provides a fully-fledged functional effect system with a rich standard library.
# Requirements
- TypeScript 5.0 or newer
- The `strict` flag enabled in your `tsconfig.json` file
```
{
// ...
"compilerOptions": {
// ...
"strict": true,
}
}
```
## Documentation
For detailed information and usage examples, please visit the [Effect website](https://www.effect.website/).
## Introduction to Effect
To get started with Effect, watch our introductory video on YouTube. This video provides an overview of Effect and its key features, making it a great starting point for newcomers:
[](https://youtu.be/SloZE4i4Zfk)
## Connect with Our Community
Join our vibrant community on Discord to interact with fellow developers, ask questions, and share your experiences. Here's the invite link to our Discord server: [Join Effect's Discord Community](https://discord.gg/hdt7t7jpvn).
## API Reference
For detailed information on the Effect API, please refer to our [API Reference](https://effect-ts.github.io/effect/).
## Pull Requests
We welcome contributions via pull requests! Here are some guidelines to help you get started:
1. Fork the repository and clone it to your local machine.
2. Create a new branch for your changes: `git checkout -b my-new-feature`
3. Install dependencies: `pnpm install` (`pnpm@8.x`)
4. Make your changes and add tests if applicable.
5. Run the tests: `pnpm test`
6. Generate the documentation if applicable: `pnpm docgen`
7. Create a changeset for your changes: before committing your changes, create a changeset to document the modifications. This helps in tracking and communicating the changes effectively. To create a changeset, run the following command: `pnpm changeset`.
8. Commit your changes: after creating the changeset, commit your changes with a descriptive commit message: `git commit -am 'Add some feature'`.
9. Push your changes to your fork: `git push origin my-new-feature`.
10. Open a pull request against our `main` branch.
### Pull Request Guidelines
- Please make sure your changes are consistent with the project's existing style and conventions.
- Please write clear commit messages and include a summary of your changes in the pull request description.
- Please make sure all tests pass and add new tests as necessary.
- If your change requires documentation, please update the relevant documentation.
- Please be patient! We will do our best to review your pull request as soon as possible.