From b524de0c6b48029de865348e7e8c0b2d9cf038d4 Mon Sep 17 00:00:00 2001 From: Rajas Date: Mon, 5 Feb 2024 09:20:39 -0500 Subject: [PATCH 1/3] Updating PR template to account for changelog entries Signed-off-by: Rajas --- .github/pull_request_template.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 9c7026bbf..2a8af7d52 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -3,7 +3,8 @@ #### Description of changes: ### Delete once you have confirmed the following: -1. Have you followed the [contribution guidelines](https://github.com/ocsf/ocsf-schema/blob/main/CONTRIBUTING.md)? -2. Did you run a local instance of the [ocsf-server](https://github.com/ocsf/ocsf-server) and ensure it ran without any errors/warnings? -3. Have you assigned appropriate labels to the PR? -4. Is your PR title in sync with the description? +1. Did you add a single line summary of changes to `Unreleased` section in the [CHANGELOG.md](https://github.com/ocsf/ocsf-schema/blob/main/CHANGELOG.md) file? +2. Have you followed the [contribution guidelines](https://github.com/ocsf/ocsf-schema/blob/main/CONTRIBUTING.md)? +3. Did you run a local instance of the [ocsf-server](https://github.com/ocsf/ocsf-server) and ensure it ran without any errors/warnings? +4. Have you assigned appropriate labels to the PR? +5. Is your PR title in sync with the description? From 2012289c4921cecb31b7507353c1e69c191d867c Mon Sep 17 00:00:00 2001 From: Rajas Date: Mon, 5 Feb 2024 09:21:31 -0500 Subject: [PATCH 2/3] Updating contribution guide to account for the new changelog file Signed-off-by: Rajas --- CONTRIBUTING.md | 41 +++++++++++++++++++++++------------------ 1 file changed, 23 insertions(+), 18 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e33e88c65..23f2515ef 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,28 @@ This documentation presents guidelines and expected etiquettes to successfully c * * * -### Key Terminology +### Pull Request Guidelines + +All contributors must submit their changes via pull requests. If you're not familiar with pull requests, please read [the GitHub documentation](https://help.github.com/en/articles/about-pull-requests). Following are a few guidelines and expectations for submitting a PR. + +1. Fork the repo that you want to contribute to ([ocsf-schema](https://github.com/ocsf/ocsf-schema), [ocsf-docs](https://github.com/ocsf/ocsf-docs), [ocsf-server](https://github.com/ocsf/ocsf-server)). +2. Make desired changes in the forked repo, test if [everything works as expected](#verifying-the-changes) and is error-free, a local instance of the [ocsf-server](https://github.com/ocsf/ocsf-server) would be essential. +3. Push the changes to the forked repo. +4. Create a **Pull Request** to merge changes into the main repo, request at least 3 approvers. +5. Follow the guidelines in the PR template. + 1. Limit the number of commits in a single PR to aid reviewers, be as specific with the change as possible. A single PR **must** contain related changes. + 2. Each commit must include a DCO [Developer's Certificate of Origin](#developers-certificate-of-origin-11). + 3. Add an entry to the `Unreleased` section in [CHANGELOG.md](https://github.com/ocsf/ocsf-schema/blob/main/CHANGELOG.md). + 3. Describe your change in as much detail as possible. + 5. Confirm that you have tested the changes, and the server run was error free. + 6. Check the Preview tab to ensure everything looks as expected. + 7. Once the PR is ready, add relevant labels, request approvers and submit it. + 8. Resolve any github action failures, warnings reported for your pull request, and stay involved in the conversation. +6. Thank you for your contribution! + +* * * + +### Key OCSF Terminology 1. **Field**: A field is a unique identifier name for a piece of data contained in OCSF. Each field also designates a corresponding data_type. 2. **Object**: An object is a collection of contextually related fields and other objects. It is also a data_type in OCSF. @@ -231,23 +252,7 @@ Sample error messages - ``` Address the errors before submitting the changes, your server run should be completely error free. -### Pull Request Guidelines - -All contributors should submit their changes via pull requests. If you're not familiar with pull requests, please read [the GitHub documentation](https://help.github.com/en/articles/about-pull-requests). Following are a few guidelines and expectations for submitting a PR. - -1. Fork the repo that you want to contribute to ([ocsf-schema](https://github.com/ocsf/ocsf-schema), [ocsf-docs](https://github.com/ocsf/ocsf-docs), [ocsf-server](https://github.com/ocsf/ocsf-server)) -2. Make desired changes in the forked repo, test if everything works as expected and is error-free, a local instance of the [ocsf-server](https://github.com/ocsf/ocsf-server) would be essential. -3. Push the changes to the forked repo -4. Create a **Pull Request** to merge changes into the main repo, request at least 3 approvers. - 1. Limit the number of commits in a single PR to aid reviewers, be as specific with the change as possible. A single PR must contain related changes. - 2. Each commit must include a DCO [Developer's Certificate of Origin](#developers-certificate-of-origin-11) - 3. Describe your change in as much detail as possible. - 4. Confirm that you have tested the changes, and the server run was error free. - 5. Check the Preview tab to ensure everything looks as expected. - 6. Once the PR is ready, add relevant labels, request approvers and submit it. - 7. Pay attention to any automated CI failures, warnings reported in the pull request, and stay involved in the conversation. - -* * * +*** ### Developer's Certificate of Origin 1.1 From 1ef74ca7269babef8e96e833897e1ba1fe32a335 Mon Sep 17 00:00:00 2001 From: Rajas Date: Mon, 5 Feb 2024 09:30:11 -0500 Subject: [PATCH 3/3] adding intial codeowners file Signed-off-by: Rajas --- .github/CODEOWNERS | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 .github/CODEOWNERS diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 000000000..873de9392 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,2 @@ +# Default Owners for everything in the repo +* @floydtree @pagbabian-splunk @Aniak5 @mikeradka @zschmerber \ No newline at end of file