-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(contributing): Added Missing CONTRIBUTING.md
Missing contribution guidelines, added
- Loading branch information
1 parent
06dfa30
commit c156ce0
Showing
1 changed file
with
43 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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,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. |