Contributing to gtop

Pull Requests are welcome! We appreciate contributions from the community to help improve gtop.

Setting up the Development Environment

To get started with development, you'll need to clone the repository and install the dependencies.

  1. Clone the repository: 

    git clone https://github.com/aksakalli/gtop.git

  2. Navigate to the project directory: 

    cd gtop

  3. Install dependencies: This project uses npm to manage its dependencies. Run the following command to install them: 

    npm install

Running Linters and Tests

Before submitting a contribution, please ensure that your code adheres to the project's standards by running the linter and tests.

Linting

This project uses prettier for code formatting. To check if your code meets the style guidelines, run:

npm run lint-check

To automatically format your code, you can run: 

npm run lint

Testing

To execute the test suite, run:

npm test

Note: The test suite is currently a placeholder. As tests are added, this command will become more important.

Submitting Changes

  1. Fork the repository on GitHub.
  2. Create a new branch for your feature or bug fix.
  3. Commit your changes.
  4. Push your branch to your fork.
  5. Submit a Pull Request to the master branch of the original repository.

Reporting Issues

If you encounter a bug or have a feature request, please open an issue. When reporting an issue, please provide the following details:

  • OS: Your operating system (e.g., Ubuntu 22.04, macOS 13.0).
  • Node version: The output of node --version.
  • gtop version: The output of npm info gtop version.
  • Description: A clear and concise description of the issue or feature request.