Merge pull request #4 from agntcy/feat/introduce-buf

feat: add proto files

Author: adamtagscherer

.cz.toml

@@ -0,0 +1,28 @@
+# Copyright AGNTCY Contributors (https://github.com/agntcy)
+# SPDX-License-Identifier: Apache-2.0
+
+name: Buf CI
+on:
+  push:
+  pull_request:
+    types: [opened, synchronize, reopened, labeled, unlabeled]
+  delete:
+permissions:
+  contents: read
+  pull-requests: write
+jobs:
+  buf:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: bufbuild/buf-action@v1
+        with:
+          token: ${{ secrets.BUF_TOKEN }}
+          input: proto
+          push:
+            paths:
+              - '**.proto'
+              - '**/buf.yaml'
+              - '**/buf.lock'
+              - 'proto/README.md'
+

.github/linters/.markdownlint.yml

@@ -1,6 +1,6 @@
 # How to Contribute
 
-Thanks for your interest in contributing to `<project name>`! Here are a few
+Thanks for your interest in contributing to OASF SDK! Here are a few
 general guidelines on contributing and reporting bugs that we ask you to review.
 Following these guidelines helps to communicate that you respect the time of the
 contributors managing and developing this open source project. In return, they
@@ -17,8 +17,7 @@ in any real-time space e.g., Slack, Discord, etc.
 ## Reporting Issues
 
 Before reporting a new issue, please ensure that the issue was not already
-reported or fixed by searching through our [issues
-list](https://github.com/org_name/repo_name/issues).
+reported or fixed by searching through our [issues list](https://github.com/agntcy/oasf-sdk/issues).
 
 When creating a new issue, please be sure to include a **title and clear
 description**, as much relevant information as possible, and, if possible, a
@@ -37,22 +36,45 @@ We expect new pull requests to include tests for any affected behavior, and, as
 we follow semantic versioning, we may reserve breaking changes until the next
 major version release.
 
+
+## Developer’s Certificate of Origin
+
+To improve tracking of who did what, we have introduced a “sign-off” procedure.
+The sign-off is a line at the end of the explanation for the commit, which
+certifies that you wrote it or otherwise have the right to pass it on as open
+source work. We use the Developer Certificate of Origin (see
+https://developercertificate.org/) for our sign-off procedure. You must include
+a sign-off in the commit message of your pull request for it to be accepted. The
+format for a sign-off is:
+
+```
+Signed-off-by: Random J Developer
+<random@developer.example.org>
+```
+
+You can use the -s when you do a git commit to simplify including a properly
+formatted sign-off in your commits. If you need to add your sign-off to a commit
+you have already made, you will need to amend:
+```
+git commit --amend --signoff
+```
+
 ## Other Ways to Contribute
 
-We welcome anyone that wants to contribute to `<project name>` to triage and
+We welcome anyone that wants to contribute to OASF SDK to triage and
 reply to open issues to help troubleshoot and fix existing bugs. Here is what
 you can do:
 
 - Help ensure that existing issues follows the recommendations from the
   _[Reporting Issues](#reporting-issues)_ section, providing feedback to the
   issue's author on what might be missing.
 - Review and update the existing content of our
-  [Wiki](https://github.com/org_name/repo_name/wiki) with up-to-date
+  [Wiki](https://github.com/agntcy/oasf-sdk/wiki) with up-to-date
   instructions and code samples.
 - Review existing pull requests, and testing patches against real existing
-  applications that use `<project name>`.
+  applications that use `oasf sdk`.
 - Write a test, or add a missing test case to an existing test.
 
-Thanks again for your interest on contributing to `<project name>`!
+Thanks again for your interest on contributing to `oasf-sdk`!
 
 :heart: