Contributing to Apache SkyWalking Eyes

Firstly, thanks for your interest in contributing! We hope that this will be a pleasant experience for you, so that you will return to continue contributing.

Code of Conduct

The project and everyone participating in it is governed by the Apache software Foundation's Code of Conduct. By participating, you are expected to adhere to this code. If you are aware of unacceptable behavior, please visit the Reporting Guidelines page and follow the instructions there.

Contribute

Most of the contributions that we receive are code contributions, but you can also contribute to the documentation or simply report solid bugs for us to fix.

Report a bug

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not happening.

Add a new feature or enhance an existing one

Before making any significant changes, please open an issue. Discussing your proposed changes ahead of time will make the contribution process smooth for everyone.

Once we‘ve discussed your changes and you’ve got your code ready, make sure that tests are passing and open your pull request. Your PR is most likely to be accepted if it:

  • Update the README.md with details of changes to the interface.
  • Include tests for new functionality.
  • References the original issue in description, e.g. “Resolves #123”, “Closes #123”, or “Fixes #123”, etc.
  • Has a good commit message.

Questions about the source code