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

improved CONTRIBUTING.md #110

Merged
merged 5 commits into from
Oct 13, 2024
Merged
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
31 changes: 12 additions & 19 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,18 @@
# Contribution Guide

Contributions are welcome! We appreciate your help in making repopack better.
You can contribute in the following ways:
Thanks for your interest in **Repopack**! 🚀 We’d love your help to make it even better. Here’s how you can get involved:

- Create an Issue - Propose a new feature or report a bug.
- Pull Request - Fix a bug, add a feature, or improve documentation.
- Share - Share your thoughts about repopack on blogs, social media, or in tech communities.
- Use repopack in your projects - Practical usage often leads to valuable feedback and improvements.

Note:
repopack is maintained by Yamadashy ([@yamadashy](https://github.com/yamadashy)). While we welcome contributions, please understand that not all suggestions may be accepted, especially if they don't align with the project's goals or coding style.
- **Create an Issue**: Spot a bug? Have an idea for a new feature? Let us know by creating an issue.
- **Submit a Pull Request**: Found something to fix or improve? Jump in and submit a PR!
- **Spread the Word**: Share your experience with Repopack on social media, blogs, or with your tech community.
- **Use Repopack**: The best feedback comes from real-world usage, so feel free to integrate Repopack into your own projects!

## Installing dependencies
## Maintainers

The `yamadashy/repopack` project uses [npm](https://www.npmjs.com/) as its package manager. Developers should have Node.js and npm installed.
Repopack is maintained by Yamadashy ([@yamadashy](https://github.com/yamadashy)). While all contributions are welcome, please understand that not every suggestion may be accepted if they don't align with the project's goals or coding standards.

After that, please install the dependencies:

```bash
npm install
```
---

## Pull Requests

Expand All @@ -45,15 +38,15 @@ To run Repopack locally:
npm run cli-run
```

## Coding Style
### Coding Style

We use [Biome](https://biomejs.dev/) for linting and formatting. Please make sure your code follows the style guide by running:

```bash
npm run lint
```

## Testing
### Testing

We use [Vitest](https://vitest.dev/) for testing. To run the tests:

Expand All @@ -67,12 +60,12 @@ For test coverage:
npm run test-coverage
```

## Documentation
### Documentation

When adding new features or making changes, please update the relevant documentation in the README.md file.

## Releasing

Releasing new versions is handled by the project maintainer. If you believe a new release is needed, please open an issue to discuss it.
New versions are managed by the maintainer. If you think a release is needed, open an issue to discuss it

Thank you for contributing to Repopack!
Loading