Repository navigation
docs: add CONTRIBUTING.md #30
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,68 @@ | ||
| # Contributing to envui | ||
|
|
||
| Thank you for your interest in contributing to envui. All contributions are welcome. | ||
|
|
||
| ## How to Contribute | ||
|
|
||
| For significant changes, please open an issue first to discuss your proposed changes. This helps ensure alignment with project goals and prevents duplicate efforts. | ||
|
|
||
| ## Development Process | ||
|
|
||
| ### Getting Started | ||
|
|
||
| 1. Fork the repository | ||
| 2. Clone your fork: `git clone https://github.com/your-username/envui.git` | ||
| 3. Create a feature branch from `develop`: `git checkout -b feature/your-feature develop` | ||
| 4. Make your changes | ||
| 5. Push to your fork: `git push origin feature/your-feature` | ||
| 6. Open a Pull Request against the `develop` branch | ||
|
|
||
| ### Commit Messages | ||
|
|
||
| Follow the [Conventional Commits](https://www.conventionalcommits.org/) specification: | ||
|
|
||
| ### Pull Requests | ||
|
|
||
| Keep pull requests small and focused. Each PR should represent a single logical change. Split large changes into multiple PRs when possible. | ||
|
|
||
| ## Development Setup | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - Node.js 18 or higher | ||
| - pnpm package manager | ||
|
|
||
| ### Installation | ||
|
|
||
| ```bash | ||
| pnpm install | ||
| ``` | ||
|
|
||
| ### Running Tests | ||
|
|
||
| ```bash | ||
| pnpm test | ||
| ``` | ||
|
|
||
| ### Building | ||
|
|
||
| ```bash | ||
| pnpm build | ||
| ``` | ||
|
|
||
| ### Linting and Formatting | ||
|
|
||
| ```bash | ||
| pnpm lint | ||
| pnpm lint:fix | ||
| pnpm format | ||
| pnpm typecheck | ||
| ``` | ||
|
|
||
| ## Questions and Support | ||
|
|
||
| If you have questions or need clarification, please open an issue. We aim to respond promptly to all inquiries. | ||
|
|
||
| ## License | ||
|
|
||
| By contributing to envui, you agree that your contributions will be licensed under the MIT License. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.