Skip to content

Commit

Permalink
Merge branch 'main' into feature/service-commander
Browse files Browse the repository at this point in the history
  • Loading branch information
SanjulaGanepola authored Sep 20, 2024
2 parents e0683fe + 57fec84 commit 6637854
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@
* Examples
* [File](config/examples/file.md)
* [Twilio](config/examples/twilio.md)
* [Sentry watch](config/examples/sentry.md)
* [Sentry watch](config/examples/sentry.md)
* [Contributing](contributing.md)
50 changes: 50 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Contributing to Manzan

Thank you for considering contributing to **Manzan**! We welcome all contributions, from bug reports and documentation improvements to feature requests and code submissions.

## How to Contribute

### 1. Reporting Bugs

If you find a bug in the project, please open an issue in the [GitHub Issues](https://github.com/ThePrez/Manzan/issues) section. Make sure to include:

- A clear and descriptive title.
- Steps to reproduce the issue.
- The expected and actual behavior.
- Any relevant logs, screenshots, or error messages.

### 2. Suggesting Features or Enhancements

We love new ideas! If you have a feature request or enhancement suggestion, please open an issue labeled as `enhancement`. Describe the following:

- The problem or limitation the feature would solve.
- A detailed description of the proposed solution.
- Alternatives you’ve considered, if applicable.

### 3. Code Contributions

We welcome pull requests (PRs) from everyone. To contribute code:

1. **Fork the repository** and clone your fork to your machine.
2. **Create a new branch** for your feature or bug fix:
```bash
git checkout -b my-feature
```
3. **Make your changes** and commit them with clear, descriptive messages:
```bash
git commit -s -m "Add feature XYZ"
```
4. **Follow the existing code style** used in the project and ensure all new code is tested, documented, and free of linting issues.
5. **Push to your fork:**
```bash
git push origin my-feature
```
6. **Submit a Pull Request** (PR) to the main branch of the main repository.

For more instructions on how to setup your development environment, build the Mazan components (handler/distributor), and run tests, check out the detailed guide [here](https://github.com/ThePrez/Manzan/blob/main/CONTRIBUTING.md).

### 4. Documentation Improvements
If you find gaps or errors in the documentation, feel free to submit a pull request with your corrections. Documentation contributions are always welcome!

## Review Process
After you submit a PR, it will be reviewed by the project maintainers. Maintain open communication with the reviewer(s) and address any feedback. Once approved, your PR will be merged into the main branch.

0 comments on commit 6637854

Please sign in to comment.