Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mayankjaviya authored Nov 19, 2023
1 parent 56a952f commit 586f19a
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Contributing to Inertia Reactive PMS

👍🎉 First off, thank you for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to Inertia Reactive PMS. Please take a moment to review these guidelines before submitting your contribution.

## How Can I Contribute?

### Reporting Bugs

Before submitting a bug report:
- Ensure the bug hasn't been reported already by checking the [issues](https://github.com/Mayank-Javiya/inertia-reactive-pms/issues).
- If you're unable to find an open issue addressing the problem, open a new one.

When creating a bug report, please provide as much detail as possible, including your environment, the steps to reproduce the issue, and any relevant error messages.

### Suggesting Enhancements

If you have ideas for enhancements, please feel free to open an issue to discuss them. We welcome your suggestions!

### Pull Requests

1. Fork the repository and create a new branch for your feature or bug fix.
2. Make your changes and ensure the code style follows the project conventions.
3. Write tests to cover your changes.
4. Ensure your code passes the existing tests and linting.
5. Submit a pull request to the `main` branch.

## Code Style

Follow the existing code style as closely as possible. If you're introducing a new feature, please consider including tests.

Happy coding!

0 comments on commit 586f19a

Please sign in to comment.