Skip to content

Latest commit

 

History

History
58 lines (46 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

58 lines (46 loc) · 1.77 KB

Contributing to the Project

We welcome contributions to our project! Follow the guidelines below to get started.

Getting Started

  1. Fork the repository: Click the "Fork" button at the top right of the repository page.
  2. Clone your fork: Clone your forked repository to your local machine. 
    git clone https://github.com/riz4d/EventGate.git
  3. Navigate to the project directory: 
    cd EventGate
  4. Install dependencies: Install the necessary dependencies using npm. 
    npm install

Development Workflow

  1. Create a new branch: Create a new branch for your feature or bugfix. 
    git checkout -b feature/your-feature-name
  2. Make your changes: Implement your feature or bugfix.
  3. Run tests: Ensure all tests pass before committing your changes. 
    npm test
  4. Commit your changes: Commit your changes with a descriptive commit message. 
    git commit -m "Add feature: your feature description"
  5. Push your branch: Push your branch to your forked repository. 
    git push origin feature/your-feature-name
  6. Create a Pull Request: Open a pull request to the main repository. Provide a clear description of your changes and any relevant information.

Code Style

  • Follow the existing code style and conventions.
  • Ensure your code passes linting checks. 
    npm run lint

Reporting Issues

If you find a bug or have a feature request, please open an issue on the repository. Provide as much detail as possible to help us understand and address the issue.

Contact

If you have any questions or need further assistance, feel free to reach out to the project maintainers.

Thank you for contributing!