Skip to content

Commit

Permalink
fix(contributing): Added Missing CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Missing contribution guidelines, added
  • Loading branch information
kourosh-alasti authored Oct 26, 2024
1 parent 06dfa30 commit c156ce0
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Contributing to [@kourosh-alasti/logger](https://github.com/kourosh-alasti/logalot)

We welcome contributions of all kinds and appreciate your time and effort.

## Getting Started

1. **Fork and Clone**: Start by forking this repository and cloning it to your local machine.
2. **Install Dependencies**: Run `npm install` to install all necessary packages.

## How to Contribute

### Reporting Issues

- Before opening a new issue, please check if it’s already been reported.
- Provide as much information as possible: describe the issue, steps to reproduce, and environment details.

### Suggesting Enhancements

- Use issues to suggest new features or enhancements.
- Please be clear on the benefit of your suggestion and provide any relevant examples.

### Making Changes

1. **Create a Branch**: For new features or fixes, create a branch named after the change. E.g., `feature/new-feature` or `fix/bug-name`.
2. **Write Clear Code**: Follow project conventions and make sure the code is easy to read.
3. **Commit Your Changes**: Use clear commit messages (e.g., `fix: resolve color picker bug`).
4. **Test**: Ensure your changes pass existing tests and add new ones if necessary.

### Pull Requests

- **Create a PR**: When ready, push your branch and create a pull request.
- **Description**: Provide a brief description of the changes in your PR.
- **Review**: Be open to feedback. We may request changes to keep the project’s quality high.

## Code Style

- Use `npm run lint` to check code style.
- Use `npm run format` to check code format.
- Use `npm run lint:fix` to fix code style.

## Need Help?

If you have questions or need help, feel free to reach out by creating an issue. We’re here to help you get started.

0 comments on commit c156ce0

Please sign in to comment.