Skip to content
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

format #7

Merged
merged 1 commit into from
Feb 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions CONTRIBUTE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,12 @@ We appreciate your interest in contributing to Intellizzer. This document provid
## Getting Started

### Prerequisites

- Node.js (version 20 or later)
- Yarn package manager

### Setup

1. Fork the repository
2. Clone your forked repository
3. Install dependencies:
Expand All @@ -21,13 +23,15 @@ We appreciate your interest in contributing to Intellizzer. This document provid
## Development Workflow

### Before Starting Development
- **Create an Issue First**:

- **Create an Issue First**:
- Before working on a new feature or bug fix, create an issue in the GitHub repository
- Describe the proposed change, its motivation, and potential implementation approach
- Wait for maintainer feedback and approval before beginning work
- This helps prevent duplicate work and ensures alignment with project goals

### Branch Strategy

- Create a new branch for each feature or bugfix
- Use descriptive branch names:
- `feature/add-new-feature`
Expand All @@ -36,17 +40,20 @@ We appreciate your interest in contributing to Intellizzer. This document provid
- **Pull Requests should target the `dev` branch**

### Code Style

- Follow TypeScript best practices
- Use ESLint for code linting
- Ensure all tests pass before submitting a pull request
- **Run `yarn format` before creating a pull request to ensure consistent code formatting**

### Commit Messages

- Use clear and descriptive commit messages
- Follow the conventional commits format:

```
<type>(optional scope): <description>

Examples:
feat: add new code review feature
fix: resolve GitHub API connection issue
Expand All @@ -56,6 +63,7 @@ We appreciate your interest in contributing to Intellizzer. This document provid
## Submitting Contributions

### Pull Request Process

1. Create an issue describing your proposed change
2. Get approval from project maintainers
3. Ensure your code follows the project's coding standards
Expand All @@ -68,11 +76,13 @@ We appreciate your interest in contributing to Intellizzer. This document provid
- Any additional context that helps reviewers understand the contribution

### Code Review

- All submissions require review from project maintainers
- Be open to feedback and constructive criticism
- Respond to review comments promptly

## Reporting Issues

- Use GitHub Issues to report bugs or suggest features
- Provide detailed information:
- Steps to reproduce
Expand All @@ -81,10 +91,12 @@ We appreciate your interest in contributing to Intellizzer. This document provid
- Environment details (OS, Node.js version, etc.)

## Code of Conduct

- Be respectful and inclusive
- Harassment and discrimination are not tolerated

## Questions?

If you have any questions, please open an issue or reach out to the maintainers.

Thank you for contributing to Intellizzer! 🚀
Thank you for contributing to Intellizzer! 🚀
29 changes: 0 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,32 +71,3 @@ We thrive on collaboration! If you have ideas, suggestions, or improvements, we'
## 📝 License

This project is proudly licensed under the MIT License. For details, check the [LICENSE](LICENSE) file.

## 🌟 Contributors

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tbody>
<tr>
<td align="center" valign="top" width="14.28%">
<a href="https://github.com/yourusername">
<img src="https://github.com/yourusername.png" width="100px;" alt="Your Name"/>
<br />
<sub><b>Your Name</b></sub>
</a>
<br />
<a href="#" title="Code">💻</a>
<a href="#" title="Ideas">🤔</a>
</td>
<!-- Add more contributors following this pattern -->
</tr>
</tbody>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->