Skip to content

Latest commit

 

History

History
88 lines (60 loc) · 2.59 KB

CONTRIBUTING.md

File metadata and controls

88 lines (60 loc) · 2.59 KB
Raw

Contributing to ExaMon

First off, thank you for considering contributing to our project!

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the issue list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

  • Use a clear and descriptive title
  • Describe the exact steps which reproduce the problem
  • Provide specific examples to demonstrate the steps
  • Describe the behavior you observed after following the steps
  • Explain which behavior you expected to see instead and why
  • Include screenshots if possible

Suggesting Enhancements

If you have a suggestion for the project, we'd love to hear about it. Please include:

  • A clear and detailed explanation of the feature
  • The motivation behind this feature
  • Any alternative solutions you've considered
  • If applicable, examples from other projects

Pull Request Process

  1. Fork the repository and create your branch from master
  2. If you've added code that should be tested, add tests
  3. Ensure the test suite passes
  4. Update the documentation if needed
  5. Issue that pull request!

Pull Request Guidelines

  • Follow our coding standards (see below)
  • Include relevant issue numbers in your PR description
  • Update the README.md with details of changes if applicable
  • The PR must pass all CI/CD checks [TBD]
  • Wait for review from maintainers

Development Setup

  1. Fork and clone the repo
  2. Create a branch: git checkout -b my-branch-name

Coding Standards

  • Use consistent code formatting
  • Write clear commit messages following Conventional Commits
  • Comment your code where necessary
  • Write tests for new features
  • Keep the code simple and maintainable

Commit Messages

We follow a basic specification:

type(scope): description
[optional body]
[optional footer]

The type should be one of the following:

Type Description
add Introduces a new feature or functionality
fix Patches a bug or resolves an issue
change Modifies existing functionality or behavior
remove Deletes or deprecates functionality
merge Combines branches or resolves conflicts
doc Updates documentation or comments

First Time Contributors

Looking for work? Check out our issues labeled good first issue or help wanted.

License

By contributing, you agree that your contributions will be licensed under the same license that covers the project.

Questions?

Don't hesitate to contact the project maintainers if you have any questions!