Skip to content

Latest commit

 

History

History
33 lines (22 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

33 lines (22 loc) · 1.9 KB

Contributing

First off, thanks for taking the time to contribute! Your efforts will help other xygeni users to get more value from the platform. We appreciate your contributions.

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. Please note we have a code of conduct, please follow it in all your interactions with the project.

Issues and feature requests

You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? Have you developed a useful detector, or an importer for a security tool not supported by default? You can help us by submitting an issue.

Bug reporting

For bug reports, please try to create bug reports that are:

  • Reproducible. Include steps to reproduce the problem.
  • Specific. Include as much detail as possible: which version, what environment, etc.
  • Unique. Do not duplicate existing opened issues.
  • Scoped to a Single Bug. One bug per report.

Even better: Submit a pull request with a fix or new feature !

How to submit a Pull Request

  1. Search our repository for open or closed Pull Requests that relate to your submission. You don't want to duplicate effort.
  2. Fork the project.
  3. Create your feature branch (git checkout -b feature/amazing_feature) or bugfix branch (git checkout -b bugfix/bug_detected). Use an good branch name for summarizing the essential of the change.
  4. Commit your changes (git commit -m 'feature: add amazing_feature').
  5. Push to the branch (git push origin feature/amazing_feature)
  6. Open a Pull Request

Your PR will be analyzed by the project maintainers, and the team will promptly suggest changes or accept and merge the PR.