Add contributing guide

[RichardChukwu]

part of Add Contributing guide to repos #31

This pull request standardizes the setup guide for the opentelemetry-network-build-tools repository using the proposed template

Next Steps:

Contributors and maintainers are encouraged to help fill in the "TBD" sections with accurate and specific details for this repository. Feedback and suggestions are highly welcomed!

This update aims to make it easier for contributors to get started with the project and follow best practices while contributing.

Please review and let me know if you have any suggestions or feedback.

cc @bjandras @yonch

[yonch]

Much of this new file CONTRIBUTING seems redundant with the repo's main README.

To accept this PR I think we should decide what goes into which file and have only a single copy of each piece of information (unless we determine duplication is necessary). We can refer the reader to the other file where appropriate.

[RichardChukwu]

Much of this new file CONTRIBUTING seems redundant with the repo's main README.

To accept this PR I think we should decide what goes into which file and have only a single copy of each piece of information (unless we determine duplication is necessary). We can refer the reader to the other file where appropriate.

Ok, @yonch so what we are trying to do with this is to ensure there is the required info needed to help new contributors to all in a single file, thereby enhancing contributor experience.

I'd suggest most of this info be included in the CONTRIBUTING alone, and then the README can contain more generic info not specific to local setup and contributing.

[yonch]

This has overlapping information with README:

• Purpose of the project
• MacOS prerequisites
• Build instructions

The README is not too long as it is, I suggest we migrate these changes to the README and eliminate the redundancies.

The repo is supporting infrastructure for building the opentelemetry-network collector, so the users of this repo are already contributors (to the other project) and so know about contributing to otel.. We should make it easier for them to reach the information and the README is a really good place to put these

[RichardChukwu]

This has overlapping information with README:

• Purpose of the project

• MacOS prerequisites

• Build instructions

The README is not too long as it is, I suggest we migrate these changes to the README and eliminate the redundancies.

The repo is supporting infrastructure for building the opentelemetry-network collector, so the users of this repo are already contributors (to the other project) and so know about contributing to otel.. We should make it easier for them to reach the information and the README is a really good place to put these

Alright then, just to be sure I understand you correctly, so no need for a CONTRIBUTING guide from what has been stated and these info should be migrated to the README instead right?

[yonch]

Much of this new file CONTRIBUTING seems redundant with the repo's main README.

To accept this PR I think we should decide what goes into which file and have only a single copy of each piece of information (unless we determine duplication is necessary). We can refer the reader to the other file where appropriate.

Since it seems hard to address my original concern (most info in CONTRIBUTING is still duplicated), and since the README is already small, that seems reasonable @RichardChukwu ?

[RichardChukwu]

Much of this new file CONTRIBUTING seems redundant with the repo's main README.

To accept this PR I think we should decide what goes into which file and have only a single copy of each piece of information (unless we determine duplication is necessary). We can refer the reader to the other file where appropriate.

Since it seems hard to address my original concern (most info in CONTRIBUTING is still duplicated), and since the README is already small, that seems reasonable @RichardChukwu ?

Duly noted

[RichardChukwu]

So I created an Issue stating the required info that will be a useful add to the README here

Kindly review @yonch