Skip to content

Commit 04e1be6

Browse files
authored
Merge pull request #7 from HiEventsDev/main
Update CONTRIBUTING.md
2 parents 33003d9 + 98af731 commit 04e1be6

File tree

1 file changed

+80
-0
lines changed

1 file changed

+80
-0
lines changed

CONTRIBUTING.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Contribution Guidelines for Hi.Events
2+
3+
Thank you for your interest in contributing to Hi.Events! We welcome contributions from the community and are excited
4+
to collaborate with you to improve our event management and ticket-selling platform. Before you start, please read through
5+
these guidelines to ensure a smooth contribution process.
6+
7+
## Table of Contents
8+
9+
1. [How Can I Contribute?](#how-can-i-contribute)
10+
- [Reporting Bugs](#reporting-bugs)
11+
- [Suggesting Enhancements](#suggesting-enhancements)
12+
- [Pull Requests](#pull-requests)
13+
2. [Development Setup](#development-setup)
14+
3. [Style Guides](#style-guides)
15+
- [Coding Standards](#coding-standards)
16+
- [Commit Messages](#commit-messages)
17+
4. [License](#license)
18+
19+
## How Can I Contribute?
20+
21+
### Reporting Bugs
22+
23+
If you find a bug, please report it by opening an issue in our [GitHub repository](https://github.com/HiEventsDev/hi.events/issues).
24+
Include as much detail as possible to help us diagnose and fix the issue.
25+
26+
### Suggesting Enhancements
27+
28+
We welcome suggestions for new features or improvements to existing functionality. To suggest an enhancement,
29+
please open an issue in our [GitHub repository](https://github.com/HiEventsDev/hi.events/issues) and provide a detailed description of the proposed
30+
enhancement and its benefits.
31+
32+
### Pull Requests
33+
34+
We accept pull requests for bug fixes, new features, and improvements.
35+
36+
Please open an issue or discussion before
37+
starting any significant work to ensure that your contribution aligns with the project's goals.
38+
39+
To submit a pull request:
40+
41+
1. Fork the repository to your GitHub account.
42+
2. Create a new branch from the `develop` branch for your changes (e.g., `feature/new-feature` or `bugfix/issue-123`).
43+
3. Make your changes, ensuring that your code adheres to our coding standards.
44+
4. Commit your changes with a descriptive commit message.
45+
5. Push your changes to your forked repository.
46+
6. Open a pull request to our `develop` branch in the original repository.
47+
48+
Please ensure that your pull request includes:
49+
50+
- A clear description of the changes and the problem they address.
51+
- Any relevant issue numbers (e.g., `Fixes #123`).
52+
- Documentation updates, if applicable.
53+
- Tests for new functionality or bug fixes, if applicable.
54+
- A demo or screenshots, if the changes are visual.
55+
56+
## Development Setup
57+
58+
To set up the development environment for Hi.Events, follow the detailed instructions in our [Getting Started with Local Development guide](https://hi.events/docs/getting-started/local-development).
59+
60+
## Style Guides
61+
62+
### Coding Standards
63+
64+
Please ensure that your code is well formatted and does not contain commented out code or unnecessary whitespace. Make
65+
sure your variable names are descriptive and follow the conventions used in the existing codebase.
66+
67+
- Follow [PSR-12](https://www.php-fig.org/psr/psr-12/) coding standards for PHP.
68+
- Use ES6+ features for JavaScript and adhere to the [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript).
69+
- For React components, follow the [React/JSX Style Guide](https://github.com/airbnb/javascript/tree/master/react).
70+
71+
### Commit Messages
72+
73+
- We don't adhere to any strict commit message format, but please ensure that your messages are clear and descriptive.
74+
- For guidelines, refer to [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/).
75+
76+
## License
77+
78+
By contributing to Hi.Events, you agree that your contributions will be licensed under the [AGPL-3.0 License](LICENSE).
79+
80+
Thank you for contributing to Hi.Events! If you have any questions, feel free to reach out to us.

0 commit comments

Comments
 (0)