Skip to content

Latest commit

 

History

History
111 lines (66 loc) · 4.93 KB

CONTRIBUTING.md

File metadata and controls

111 lines (66 loc) · 4.93 KB
Raw

Contributing to Sec1 Security

Sec1

First off, thanks for taking the time to contribute!

The following is a set of guidelines for contributing to Sec1 Security, which is hosted in the Jenkins Organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Code of Conduct

This project and everyone participating in it is governed by the Jenkins Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to security@sec1.io

What should I know before I get started?

Sec1 Security and Jenkins

Plugin Development

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for Sec1 Security. Following these guidelines helps maintainers and the community understand your report.

Before Submitting A Bug Report

  • Perform a cursory search to see if the bug has already been reported.
  • Determine which repository the problem should be reported in.

How Do I Submit A (Good) Bug Report?

Bugs are tracked as [GitHub issues](link to your GitHub issues). Explain the problem and include additional details:

  • 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 and animated GIFs which show you following the described steps and clearly demonstrate the problem.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Sec1 Security, including completely new features and minor improvements to existing functionality.

Before Submitting An Enhancement Suggestion

  • Perform a cursory search to see if the enhancement has already been suggested.
  • Determine which repository the enhancement should be suggested in.

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. Provide the following information:

  • Use a clear and descriptive title
  • Provide a step-by-step description of the suggested enhancement
  • Provide specific examples to illustrate the steps
  • Describe the current behavior and how your feature would change that behavior
  • Explain why this enhancement would be useful to most [Your Plugin Name] users
  • Specify which version of [Your Plugin Name] you're using

Your First Code Contribution

Unsure where to begin contributing to Sec1 Security? You can start by looking through the beginner and help-wanted issues:

  • Beginner issues - issues which should only require a few lines of code, and a test or two.
  • Help wanted issues - issues which should be a bit more involved than beginner issues.

Pull Requests

The process described here has several goals:

  • Maintain Sec1 Security's quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible Sec1 Security
  • Enable a sustainable system for [Your Plugin Name]'s maintainers to review contributions

Please follow these steps to have your contribution considered by the maintainers:

  1. After you submit your pull request, verify that all status checks are passing

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Java Styleguide

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

Getting Help

If you have a question about Sec1 Security, or need help using it, please start by checking the documentation. If you can't find the answer there, you can ask for help by dropping a note to security@sec1.io.

Remember that contributions to this repository are made under the Apache License 2.0. This means that any contributions you make will be licensed under the same license.