This repository has been archived by the owner on Jan 6, 2025. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 37
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
4 changed files
with
1,186 additions
and
1,095 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
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
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 |
---|---|---|
|
@@ -1540,3 +1540,50 @@ console.log(isDeprecated(schema)); // true | |
# License | ||
|
||
The MIT License (MIT) | ||
|
||
# Contributing Guidelines | ||
|
||
Thank you for considering contributing to our project! Here are some guidelines to help you get started: | ||
|
||
## Reporting Bugs | ||
|
||
If you have found a bug, please open an issue on our [issue tracker](https://github.com/Effect-TS/schema/issues) and provide as much detail as possible. This should include: | ||
|
||
- A clear and concise description of the problem | ||
- Steps to reproduce the problem | ||
- The expected behavior | ||
- The actual behavior | ||
- Any relevant error messages or logs | ||
|
||
## Suggesting Enhancements | ||
|
||
If you have an idea for an enhancement or a new feature, please open an issue on our [issue tracker](https://github.com/Effect-TS/schema/issues) and provide as much detail as possible. This should include: | ||
|
||
- A clear and concise description of the enhancement or feature | ||
- Any potential benefits or use cases | ||
- Any potential drawbacks or trade-offs | ||
|
||
## 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` (`[email protected]`) | ||
4. Make your changes and add tests if applicable. | ||
5. Run the tests: `pnpm test` | ||
6. Commit your changes: `git commit -am 'Add some feature'` | ||
7. Push your changes to your fork: `git push origin my-new-feature` | ||
8. 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. | ||
|
||
## License | ||
|
||
By contributing to this project, you agree that your contributions will be licensed under the project's [MIT License](./LICENSE). |
Oops, something went wrong.