You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
3
+
Thank you for your interest in contributing to Hi.Events! We welcome contributions from the community and are excited to collaborate with you to improve our event management and ticket-selling platform. Before you start, please read these guidelines to ensure a smooth contribution process.
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
+
If you find a bug, please report it by opening an issue in our [GitHub repository](https://github.com/HiEventsDev/hi.events/issues). Include as much detail as possible to help us diagnose and fix the issue.
25
26
26
27
### Suggesting Enhancements
27
28
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.
29
+
We welcome suggestions for new features or improvements to existing functionality. To suggest an enhancement, please open an issue in our [GitHub repository](https://github.com/HiEventsDev/hi.events/issues) and provide a detailed description of the proposed enhancement and its benefits.
31
30
32
31
### Pull Requests
33
32
34
-
We accept pull requests for bug fixes, new features, and improvements.
33
+
We accept pull requests for bug fixes, new features, and improvements.
35
34
36
-
Please open an issue or discussion before
37
-
starting any significant work to ensure that your contribution aligns with the project's goals.
35
+
⚠️ Please open an issue or discussion before starting any significant work to ensure that your contribution aligns with the project's goals.
38
36
39
37
To submit a pull request:
40
38
@@ -43,7 +41,7 @@ To submit a pull request:
43
41
3. Make your changes, ensuring that your code adheres to our coding standards.
44
42
4. Commit your changes with a descriptive commit message.
45
43
5. Push your changes to your forked repository.
46
-
6. Open a pull request to our`develop` branch in the original repository.
44
+
6. Open a pull request to the`develop` branch in the original repository.
47
45
48
46
Please ensure that your pull request includes:
49
47
@@ -53,32 +51,96 @@ Please ensure that your pull request includes:
53
51
- Tests for new functionality or bug fixes, if applicable.
54
52
- A demo or screenshots, if the changes are visual.
55
53
56
-
Once you create a pull request, a CLA bot will automatically check if you have signed the Contributor License Agreement (CLA).
57
-
Signing is as simple as leaving a comment on the pull request with the message `I have read the CLA Document and I hereby sign the CLA`.
58
-
We require all contributors to sign the CLA to ensure that we have the necessary permissions to use and distribute your contributions.
54
+
Once you create a pull request, a CLA bot will automatically check if you have signed the Contributor License Agreement (CLA). Signing is as simple as leaving a comment on the pull request with the message: `I have read the CLA Document and I hereby sign the CLA`. We require all contributors to sign the CLA to ensure that we have the necessary permissions to use and distribute your contributions.
59
55
60
56
## Development Setup
61
57
62
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).
63
59
64
-
## Style Guides
60
+
###Style Guides
65
61
66
-
### Coding Standards
62
+
####Coding Standards
67
63
68
-
Please ensure that your code is well formatted and does not contain commented out code or unnecessary whitespace. Make
69
-
sure your variable names are descriptive and follow the conventions used in the existing codebase.
64
+
Please ensure that your code is well-formatted and does not contain commented-out code or unnecessary whitespace. Use descriptive variable names that follow the conventions used in the existing codebase.
70
65
71
66
- Follow [PSR-12](https://www.php-fig.org/psr/psr-12/) coding standards for PHP.
72
67
- Use ES6+ features for JavaScript and adhere to the [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript).
73
68
- For React components, follow the [React/JSX Style Guide](https://github.com/airbnb/javascript/tree/master/react).
74
69
75
-
### Commit Messages
70
+
####Commit Messages
76
71
77
-
- We don't adhere to any strict commit message format, but please ensure that your messages are clear and descriptive.
78
-
- For guidelines, refer to [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/).
72
+
We don't adhere to any strict commit message format, but please ensure that your messages are clear and descriptive. For guidelines, refer to [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/).
73
+
74
+
### Translations
75
+
76
+
#### Backend
77
+
78
+
Please wrap all translatable strings in the `__()` helper function. For example:
79
+
80
+
```php
81
+
return [
82
+
'welcome' => __('Welcome to Hi.Events!'),
83
+
];
84
+
```
85
+
86
+
#### Translation Commands
87
+
88
+
To extract messages from the codebase, use the following command:
89
+
90
+
```bash
91
+
php artisan langscanner
92
+
```
93
+
94
+
This will update the translation files in the `backend/lang` directory.
95
+
96
+
#### Frontend
97
+
98
+
[Lingui](https://lingui.dev/) is used for frontend translations. Please wrap all translatable strings in either the `t` function or `Trans` component. For example:
99
+
100
+
```jsx
101
+
import { t } from'@lingui/macro';
102
+
103
+
constMyComponent= () => {
104
+
return<div>{t`Welcome to Hi.Events!`}</div>;
105
+
};
106
+
```
107
+
108
+
#### Translation Commands
109
+
110
+
To extract messages from the codebase and compile translations, use the following commands:
111
+
112
+
```bash
113
+
yarn messages:extract && yarn messages:compile
114
+
```
115
+
116
+
To list all untranslated messages, run:
117
+
118
+
```bash
119
+
cd frontend/scripts && ./list_untranslated_strings.sh
120
+
```
121
+
122
+
### Database Changes
123
+
124
+
If you are making changes to the database schema, please update the migration files accordingly.
125
+
126
+
We use [Laravel Migrations](https://laravel.com/docs/master/migrations) to manage schema changes. Migration files should only contain schema changes and no logic.
127
+
128
+
To generate a new migration file, use:
129
+
130
+
```bash
131
+
php artisan make:migration create_XXX_table
132
+
```
133
+
134
+
After running the migration, update the Domain Objects with:
135
+
136
+
```bash
137
+
php artisan generate-domain-objects
138
+
```
139
+
140
+
This will update the Domain Objects in `backend/app/DomainObjects` based on the schema changes.
79
141
80
142
## License
81
143
82
-
By contributing to Hi.Events, you agree that your contributions will be licensed under the [AGPL-3.0 License](LICENSE).
144
+
By contributing to Hi.Events, you agree that your contributions will be licensed under the [AGPL-3.0 License with additional terms](LICENSE).
83
145
84
-
Thank you for contributing to Hi.Events! If you have any questions, feel free to reach out to us.
146
+
Thank you for contributing to Hi.Events! If you have any questions, feel free to reach out to us.
0 commit comments