Thank you for your interest in contributing to Perfmon! We welcome contributions from everyone. This document provides guidelines for contributing to the project.
Bugs are tracked as GitHub issues. When creating a bug report, please include as much detail as possible:
- A clear, descriptive title.
- The version of Perfmon you are using.
- Your operating system and terminal emulator.
- Steps to reproduce the bug.
- Actual vs. expected behavior.
If you have an idea for a feature, please search existing issues to see if it's already been suggested. If not, open a new issue and describe:
- Why the feature would be useful.
- How it should work.
- Any relevant screenshots or mockups.
- Fork the repository.
- Clone your fork locally.
- Create a new branch for your changes.
git checkout -b feature/your-feature-name
- Make your changes and write tests if applicable.
- Ensure all tests pass and the code is formatted correctly.
- Push your branch to your fork.
- Open a Pull Request against the
mainbranch.
- Go 1.22 or later.
make(optional, for using the Makefile).
- Run locally:
make run # or go run .
- Build binary:
make build # or go build -o perfmon - Run tests:
make test # or go test ./...
- Follow standard Go conventions and idioms.
- Format your code with
gofmt. - Use descriptive names for variables and functions.
- Keep functions small and focused on a single task.
- Use the imperative mood ("Add feature" not "Added feature").
- Keep the first line short (under 50 characters).
- Provide more detail in the body if necessary, separated by a blank line.
By contributing, you agree that your contributions will be licensed under the project's MIT License.