Skip to content

Commit ba9968b

Browse files
VoxDroidVoxDroid
committed
docs: update repository structure and folder structure, create doc files
1 parent dbbb1d4 commit ba9968b

16 files changed

Lines changed: 512 additions & 54 deletions

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Pull Request Template
2+
3+
Thank you for contributing to the Event Management System (EMS)! Please fill out the sections below to help us review your pull request efficiently. Ensure your changes align with the [CONTRIBUTING.md](CONTRIBUTING.md) guidelines and the [Code of Conduct](CODE_OF_CONDUCT.md).
4+
5+
## Description
6+
7+
Provide a clear and concise description of the changes or features you've implemented. Explain the purpose of this pull request and what problem it solves.
8+
9+
- **What does this PR do?**
10+
- **Why is this change needed?**
11+
- **Related issue (if applicable):** Link to the issue (e.g., `Fixes #123`)
12+
13+
## Type of Change
14+
15+
Check the applicable boxes:
16+
17+
- [ ] Bug fix (non-breaking change that fixes an issue)
18+
- [ ] New feature (non-breaking change that adds functionality)
19+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
20+
- [ ] Documentation update
21+
- [ ] Refactoring (code improvements without changing functionality)
22+
- [ ] Other (please specify):
23+
24+
## How Has This Been Tested?
25+
26+
Describe how you tested your changes to ensure they work as expected.
27+
28+
- **Automated Tests:** Did you add or update unit tests? (e.g., `vendor/bin/phpunit tests`)
29+
- **Manual Tests:** What steps did you perform to verify the changes? (e.g., "Tested event creation in the web interface")
30+
- **Browsers Tested:** List browsers used for testing (e.g., Chrome, Firefox)
31+
- **Environment:** Specify the environment (e.g., PHP 8.0, MySQL 5.7, Apache)
32+
33+
## Screenshots (if applicable)
34+
35+
If your changes affect the UI, please attach screenshots or GIFs to demonstrate the changes. For example, include before-and-after images for visual updates.
36+
37+
## Checklist
38+
39+
Ensure your pull request meets the following requirements:
40+
41+
- [ ] My code follows the [PSR-12](https://www.php-fig.org/psr/psr-12/) coding standards for PHP and the [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript) for JavaScript.
42+
- [ ] I have updated or added relevant documentation in `docs/` or `README.md`.
43+
- [ ] I have added tests that cover my changes, or existing tests are sufficient.
44+
- [ ] All new and existing tests pass (`vendor/bin/phpunit tests`).
45+
- [ ] My changes do not introduce new warnings or errors (e.g., linting errors).
46+
- [ ] I have checked for conflicts with the `main` branch.
47+
- [ ] My commit messages follow the format: `[type]: Short description` (e.g., `feat: Add event filtering`).
48+
49+
## Additional Notes
50+
51+
Add any extra information that might help reviewers understand your changes, such as:
52+
53+
- Challenges faced during implementation.
54+
- Future improvements planned for this feature.
55+
- Dependencies introduced (if any).
56+
57+
## Security Considerations
58+
59+
If your changes involve security-related updates (e.g., authentication, database queries):
60+
61+
- [ ] I have used prepared statements for all database queries to prevent SQL injection.
62+
- [ ] I have followed security best practices outlined in [SECURITY.md](SECURITY.md).
63+
- [ ] I have not exposed sensitive information (e.g., credentials, API keys).
64+
65+
If this PR addresses a security vulnerability, please contact [izeno.contact@gmail.com](mailto:izeno.contact@gmail.com) privately instead of including details here.
66+
67+
## Reviewer Instructions
68+
69+
For maintainers (@VoxDroid and others):
70+
71+
- Review the code for adherence to coding standards.
72+
- Verify that tests pass and cover the changes.
73+
- Test the changes locally if they involve UI or complex logic.
74+
- Provide constructive feedback within 7 days of the PR submission.
75+
76+
## Contact
77+
78+
For questions about this pull request, reach out to:
79+
80+
- **GitHub:** [@VoxDroid](https://github.com/VoxDroid)
81+
- **Email:** [izeno.contact@gmail.com](mailto:izeno.contact@gmail.com)
82+
83+
Thank you for your contribution to EMS!

‎CODE_OF_CONDUCT.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We, as contributors and maintainers of the Event Management System (EMS), pledge to make participation in our project and community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to a positive environment include:
10+
11+
- Using welcoming and inclusive language.
12+
- Being respectful of differing viewpoints and experiences.
13+
- Gracefully accepting constructive criticism.
14+
- Focusing on what is best for the community.
15+
- Showing empathy towards other community members.
16+
17+
Examples of unacceptable behavior include:
18+
19+
- The use of sexualized language or imagery and unwelcome sexual attention or advances.
20+
- Trolling, insulting/derogatory comments, and personal or political attacks.
21+
- Public or private harassment.
22+
- Publishing others' private information, such as physical or electronic addresses, without explicit permission.
23+
- Other conduct which could reasonably be considered inappropriate in a professional setting.
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [izeno.contact@gmail.com](mailto:izeno.contact@gmail.com). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html).
44+
45+
For answers to common questions about this code of conduct, see [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq).
46+
47+
## Contact
48+
49+
For questions or to report violations, please contact:
50+
51+
- **Email:** [izeno.contact@gmail.com](mailto:izeno.contact@gmail.com)
52+
- **GitHub:** [@VoxDroid](https://github.com/VoxDroid)

‎CONTRIBUTING.md‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
# Contributing to EMS
2+
3+
Thank you for your interest in contributing to the Event Management System (EMS)! We welcome contributions from the community to improve the project. This document outlines the process for contributing, setting up your development environment, and submitting changes.
4+
5+
## How to Contribute
6+
7+
1. **Find an Issue:**
8+
- Browse open issues in the [GitHub Issues](https://github.com/VoxDroid/Event-Management-System/issues) page.
9+
- Look for issues labeled `good first issue` or `help wanted` for beginner-friendly tasks.
10+
- If you have an idea for a new feature or bug fix, open a new issue to discuss it.
11+
12+
2. **Fork the Repository:**
13+
- Fork the [EMS repository](https://github.com/VoxDroid/EMS) to your GitHub account.
14+
- Clone your fork to your local machine:
15+
```bash
16+
git clone https://github.com/YOUR_USERNAME/EMS.git
17+
cd EMS
18+
```
19+
20+
3. **Set Up Your Development Environment:**
21+
- Follow the [Installation](#installation) section in the [README.md](README.md) to set up the project.
22+
- Install additional development tools:
23+
- **PHPUnit** for PHP testing: `composer require --dev phpunit/phpunit`
24+
- **ESLint** for JavaScript linting: `npm install eslint --save-dev`
25+
- Configure pre-commit hooks (if available) to enforce coding standards.
26+
27+
4. **Create a Branch:**
28+
- Create a new branch for your feature or bug fix:
29+
```bash
30+
git checkout -b feature/your-feature-name
31+
```
32+
- Use descriptive branch names (e.g., `fix/login-bug`, `feature/calendar-export`).
33+
34+
5. **Make Changes:**
35+
- Follow the [Coding Standards](#coding-standards) below.
36+
- Write tests for new features or bug fixes.
37+
- Update documentation in `docs/` or `README.md` if your changes affect setup or usage.
38+
39+
6. **Test Your Changes:**
40+
- Run the test suite:
41+
```bash
42+
vendor/bin/phpunit tests
43+
```
44+
- Manually test the application in your browser to ensure functionality.
45+
- Verify that your changes do not break existing features.
46+
47+
7. **Commit Your Changes:**
48+
- Write clear, concise commit messages:
49+
```bash
50+
git commit -m "Add feature: calendar export functionality"
51+
```
52+
- Group related changes into logical commits.
53+
54+
8. **Push and Open a Pull Request:**
55+
- Push your branch to your fork:
56+
```bash
57+
git push origin feature/your-feature-name
58+
```
59+
- Open a pull request (PR) against the `main` branch of the [EMS repository](https://github.com/VoxDroid/EMS).
60+
- In the PR description, include:
61+
- A summary of your changes.
62+
- Reference to the related issue (e.g., `Fixes #123`).
63+
- Any additional context or screenshots (especially for UI changes).
64+
65+
9. **Respond to Feedback:**
66+
- Maintainers will review your PR and may request changes.
67+
- Address feedback promptly and push updates to the same branch.
68+
- Once approved, your changes will be merged!
69+
70+
## Coding Standards
71+
72+
- **PHP:**
73+
- Follow [PSR-12](https://www.php-fig.org/psr/psr-12/) coding standards.
74+
- Use meaningful variable and function names.
75+
- Add PHPDoc comments for functions and classes.
76+
- Avoid inline HTML in PHP files; use templates where possible.
77+
78+
- **JavaScript/CSS:**
79+
- Follow [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript).
80+
- Use SCSS for stylesheets and organize in `ASSETS/CSS/`.
81+
- Minify production assets using `npm run build`.
82+
83+
- **HTML:**
84+
- Write semantic HTML5.
85+
- Ensure accessibility (e.g., ARIA attributes, alt text for images).
86+
87+
- **Database:**
88+
- Use prepared statements for all database queries to prevent SQL injection.
89+
- Follow the existing schema in `database/schema.sql`.
90+
- Document any schema changes in `docs/database.md`.
91+
92+
- **Commits:**
93+
- Use the format: `[type]: Short description` (e.g., `feat: Add event filtering`, `fix: Resolve login redirect bug`).
94+
- Types: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`.
95+
96+
## Code of Conduct
97+
98+
All contributors are expected to adhere to the [Code of Conduct](CODE_OF_CONDUCT.md). Be respectful, inclusive, and professional in all interactions.
99+
100+
## Reporting Bugs
101+
102+
- Use the [GitHub Issues](https://github.com/VoxDroid/Event-Management-System/issues) page to report bugs.
103+
- Provide a clear title, description, steps to reproduce, expected behavior, and actual behavior.
104+
- Include screenshots or logs if applicable.
105+
106+
## Suggesting Features
107+
108+
- Open an issue with the label `enhancement`.
109+
- Describe the feature, its use case, and potential implementation ideas.
110+
- Discuss with maintainers before starting work to ensure alignment.
111+
112+
## Security Vulnerabilities
113+
114+
If you discover a security issue, please report it privately to [izeno.contact@gmail.com](mailto:izeno.contact@gmail.com). Do not disclose vulnerabilities publicly until they are resolved. See [SECURITY.md](SECURITY.md) for details.
115+
116+
## Questions?
117+
118+
Contact the project maintainer:
119+
120+
- **Email:** [izeno.contact@gmail.com](mailto:izeno.contact@gmail.com)
121+
- **GitHub:** [@VoxDroid](https://github.com/VoxDroid)
122+
123+
Thank you for contributing to EMS! Your efforts help make this project better for everyone.

0 commit comments

Comments
 (0)