Skip to content

Commit

Permalink
add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Change-Id: I239703f27b8cce72c44cd01798857c0cbec830fa
  • Loading branch information
rdementi committed Mar 15, 2024
1 parent e7dfe43 commit c283c98
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 1 deletion.
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
--------------------------------------------------------------------------------
Contributing to Intel® Performance Counter Monitor (Intel® PCM)
--------------------------------------------------------------------------------

Everyone is welcome to contribute. Patches may be submitted using GitHub pull requests (PRs).

--------------------------------------------------------------------------------
License
--------------------------------------------------------------------------------

(Intel® PCM) is licensed using a [BSD 3-clause license](https://github.com/intel/pcm/blob/master/LICENSE). All code submitted to the project is required to carry that license.

--------------------------------------------------------------------------------
Coding Style
--------------------------------------------------------------------------------

While we don't enforce stringent coding style requirements, we do encourage adherence to standard coding style practices, such as those outlined in the Google C++ Style Guide (https://google.github.io/styleguide/cppguide.html). When submitting patches, we request that you maintain the style consistency with the surrounding code. We discourage the use of tabs; please use 4 spaces for indentation instead.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
BSD 3-Clause License

Copyright (c) 2009-2023, Intel Corporation
Copyright (c) 2009-2024, Intel Corporation
Copyright (c) 2016-2020, opcm
All rights reserved.

Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Intel® Performance Counter Monitor (Intel® PCM) is an application progra

*Github repository statistics:* ![Custom badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fhetthbszh0.execute-api.us-east-2.amazonaws.com%2Fdefault%2Fpcm-clones) ![Custom badge](https://img.shields.io/endpoint?url=https%3A%2F%2F5urjfrshcd.execute-api.us-east-2.amazonaws.com%2Fdefault%2Fpcm-yesterday-clones) ![Custom badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fcsqqh18g3l.execute-api.us-east-2.amazonaws.com%2Fdefault%2Fpcm-today-clones)

We welcome bug reports and enhancement requests, which can be submitted via the "Issues" section on GitHub. For those interested in contributing to the code, please refer to the guidelines outlined in the CONTRIBUTING.md file.

--------------------------------------------------------------------------------
Current Build Status
--------------------------------------------------------------------------------
Expand Down

0 comments on commit c283c98

Please sign in to comment.