Skip to content

Commit

Permalink
doc: add contributing guide and badges bar (#160)
Browse files Browse the repository at this point in the history
* Added badges/shields bar to README

* Create CONTRIBUTING.md

* Add Contributing section to README

* Add info on how to submit bugs to README.md

* add crates.io bage
  • Loading branch information
eparshut authored Sep 26, 2024
1 parent 118fb7e commit 48e75eb
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 0 deletions.
27 changes: 27 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Contributing to Intel® Instrumentation and Tracing Technology (ITT) and Just-In-Time (JIT) API

We welcome contributions from everyone. Your efforts help improve the project and are greatly appreciated.

## Contribution Process

- **Fork** the repository
- **Make Changes**:
- Clone your fork
- Create a new branch
- Implement your changes and commit with a clear message
- **Pull Request**:
- Push to your fork
- Open a pull request to merge your branch into the main repository with a clear title and description

## Review

- Maintainers will review your pull request
- You may be asked to make changes
- Approved changes will be merged

## Licensing

- All code is dual licensed under GPLv2 and 3-Clause BSD
- All contributions must carry these licenses

Thank you for contributing to Intel® Instrumentation and Tracing Technology (ITT) and Just-In-Time (JIT) API
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
Intel® Instrumentation and Tracing Technology (ITT) and Just-In-Time (JIT) API
==================================================================================

[![Build Status](https://github.com/intel/ittapi/actions/workflows/main.yml/badge.svg?branch=master&event=push)](https://github.com/intel/ittapi/actions)
[![CodeQL](https://github.com/intel/ittapi/actions/workflows/codeql.yml/badge.svg?branch=master)](https://github.com/intel/ittapi/security/code-scanning/tools/CodeQL/status)
[![Package on conda-forge](https://img.shields.io/conda/vn/conda-forge/ittapi.svg)](https://anaconda.org/conda-forge/ittapi)
[![Package on PyPI](https://img.shields.io/pypi/v/ittapi)](https://pypi.org/project/ittapi)
[![Package on crates.io](https://img.shields.io/crates/v/ittapi.svg)](https://crates.io/crates/ittapi)
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/intel/ittapi/badge)](https://securityscorecards.dev/viewer/?uri=github.com/intel/ittapi)

This ITT/JIT open source profiling API includes:

- Instrumentation and Tracing Technology (ITT) API
Expand Down Expand Up @@ -41,6 +48,11 @@ optional arguments:

All code in the repo is dual licensed under GPLv2 and 3-Clause BSD licenses

### Contributing

To contribute, please see our [contributing guide](CONTRIBUTING.md)
To report bugs or request enhancements, please use the "Issues" page on GitHub

### Security

Please refer to the [security policy](SECURITY.md) for reporting vulnerabilties.

0 comments on commit 48e75eb

Please sign in to comment.