Skip to content

Commit

Permalink
chore: add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gwansikk committed Oct 12, 2024
1 parent f14e3a5 commit e04927d
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# CONTRIBUTING

We welcome contributions from everyone in the community. Thank you for your interest in this project.
Please follow the procedures and rules below to ensure that all community members can contribute.

- All contributors must adhere to the [Code of Conduct](https://www.contributor-covenant.org/).

## Getting Started

- Fork this repository to your personal repository.
- Clone it to your local system using `git clone [URL of your forked repository]`.
- Create a new working branch with `git checkout -b [new branch name]`.

## Issues

### 1. Check for Duplicates

Before creating a new issue, please check existing issues.

### 2. Have a Question?

GitHub issues are for bugs and enhancement suggestions. For questions about the project, please use our contact methods.

### 3. Found a Bug?

If you want to report a bug, please use the bug issue template. It contains questions to help us track and diagnose the issue accurately.

### 4. Feature Requests

When requesting a new feature, please describe the necessity and expected benefits in as much detail as possible.

## Pull Requests

You can submit a PR directly. All commit messages and pull request titles should follow this format:

```markdown
<type>[optional package scope]: <description>

[optional body]

[optional footer(s)]
```

## Code Review

- Maintainers or project managers will review the PR and provide feedback if changes are necessary.
- If there are any modifications needed based on feedback, please update your branch with additional commits.

## License

All code contributed to this project will be distributed under the [project's license](https://github.com/gwansikk/modulepack/blob/main/LICENSE).

0 comments on commit e04927d

Please sign in to comment.