CONTRIBUTING.md

Contributing to Infinispan Console

Thank you for your interest in contributing to Infinispan Console! We value community contributions and appreciate your efforts to improve our project. To ensure a smooth contribution process, please review the following guidelines.

You can access our documentation at Infinispan Documentation.

If you have any questions or need assistance, please feel free to reach out to us via Zulip chat.

Table of Contents

• Getting Started
  • Prerequisites
  • Setting Up Your Development Environment
• Contributing
  • Reporting Bugs
  • Submitting Enhancements
  • Code Contributions
• Development Guidelines
  • Coding Standards
  • Commit Message Guidelines
  • Testing

Getting Started

Prerequisites

Before you start contributing, make sure you have the following prerequisites installed:

• Infinispan server
• Node 18 or greater
• Git

Setting Up Your Development Environment

1. Fork this repository to your GitHub account.

2. Clone your forked repository to your local machine.

   git clone https://github.com/your-username/infinispan-console.git

3. Navigate to project directory.

   cd infinispan-console 

4. Installing dependencies:

   npm install

Running locally

npm run start:dev

You can access the console at http://localhost:4010. The console will automatically reload when you make changes.

Contributing

Reporting Bugs

If you encounter a bug, please open a GitHub issue with a clear and detailed description of the problem. Include any relevant error messages and steps to reproduce the issue.

Submitting Enhancements

We welcome suggestions and enhancements. Please open an Github issue to discuss your idea before implementing it. This helps ensure that your work aligns with the project's goals.

Code Contributions

1. Ensure that your code adheres to the coding standards.

2. Create a new branch for your changes:

   git checkout -b branch-name

3. Commit your changes with clear and concise messages. The commit message must includes a reference to the corresponding JIRA issue (eg. commit message: "ISPN-1234 JIRA TITLE...")

4. Push your branch to your forked repository:

   git push origin feature/your-feature

5. Submit a pull request (PR) to the main repository.

Development Guidelines

Coding Standards

Please format your code using Prettier or by running:

npm run format

Commit Message Guidelines

Follow this format for commit messages: Start with the JIRA issue number, followed by a JIRA/Issue title:

ISPN-1234 JIRA TITLE...

Testing

Ensure that your code includes unit tests when applicable. All tests should pass before submitting a PR.

e2e testing:

1. Run the Infinispan server using ./run-server-for-e2e.sh, which will download and run the server.
2. Run the following command with the -De2e=true flag:

mvn clean install -De2e=true

Unit testing:

npm run test