Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
113 lines (83 loc) · 4.38 KB

CONTRIBUTING.md

File metadata and controls

113 lines (83 loc) · 4.38 KB
Raw

Contributing to Event Management System

Thank you for your interest in contributing to the Event Management System project! We appreciate your time and effort to improve this project, and we want to ensure that the process is as smooth and collaborative as possible.

The following is a set of guidelines to help you contribute to this project.

Table of Contents

  1. How Can I Contribute?
  2. Setting Up Your Environment
  3. Pull Request Guidelines
  4. Code of Conduct

How Can I Contribute?

Reporting Bugs

If you've found a bug, we want to hear about it! Before reporting, please:

  • Ensure the bug hasn’t already been reported by searching open issues.
  • Check if the issue is already being worked on by reviewing recent pull requests.

When submitting a bug report:

  1. Provide a clear and descriptive title.
  2. Include the steps to reproduce the issue.
  3. Share screenshots or logs if relevant.
  4. Specify the environment where the bug occurred (browser, operating system, etc.).

Feature Requests

We welcome feature suggestions that can improve the Event Management System. If you have an idea:

In your feature request, please describe:

  • The motivation behind your suggestion.
  • How it benefits the project or its users.
  • Any potential challenges or trade-offs.

Contributing Code

If you want to contribute by writing code, follow these steps:

  1. Fork the repository to your own GitHub account.

  2. Clone the project to your local machine:

    git clone https://github.com/your-username/event-management-system.git

  3. Create a new branch for your feature or bugfix:

    git checkout -b your-feature-branch

  4. Make your changes and commit them with clear, descriptive messages:

    git commit -m "Add feature XYZ"

  5. Push your branch to GitHub:

    git push origin your-feature-branch

  6. Create a pull request (PR) from your branch to the main branch of this repository.

Setting Up Your Environment

To get started with the Event Management System locally:

  1. Clone the repository:

    git clone https://github.com/ThePral/Event-Management-System.git
cd event-management-system

  2. Install dependencies:

    # For Node.js:
npm install

# For Python backend (if applicable):
pip install -r requirements.txt

  3. Run the application locally:

    npm start

  4. Make sure to write tests and run them before submitting a pull request:

    npm test

Pull Request Guidelines

To ensure your pull request is reviewed and merged efficiently, please follow these guidelines:

  • Provide a detailed description of the changes.
  • Reference any related issues (e.g., "Fixes #123").
  • Make sure your code follows the style guide of the project (e.g., linting and formatting).
  • Include tests for your changes where applicable.
  • If the PR introduces a new feature, make sure the documentation (e.g., README, Wiki) is updated accordingly. We will review your pull request and provide feedback. If changes are requested, please address them before the PR is merged.

Code of Conduct

We expect everyone to follow our Code of Conduct when participating in this project. Please treat others with respect and kindness, and always aim to foster a welcoming environment.

Thank You!

Thank you for taking the time to contribute to the Event Management System! Your help is greatly appreciated, and we look forward to collaborating with you. If you have any questions, feel free to start a discussion or reach out via email.