Skip to content

Commit

Permalink
Merge pull request #110 from Innovatorcloudy/patch-2
Browse files Browse the repository at this point in the history
improved  CONTRIBUTING.md
  • Loading branch information
yamadashy authored Oct 13, 2024
2 parents 874bb55 + 287001b commit af9c4c5
Showing 1 changed file with 12 additions and 19 deletions.
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!

0 comments on commit af9c4c5

Please sign in to comment.