Skip to content

Commit

Permalink
[skip ci] Clarify guidance for #1864. (#1869)
Browse files Browse the repository at this point in the history
  • Loading branch information
aj-stein-nist authored Aug 2, 2023
1 parent 1f45b52 commit 6374f41
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 7 deletions.
9 changes: 2 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,7 @@ We track our current work items using GitHub [project cards](https://github.com/

## Contribution options

The OSCAL project is producing several types of deliverables, including the following:
- *Schemas* for the OSCAL component models
- *Schematron definitions*, which are basically an extension of the XML schemas that provide more validation capabilities
- *XSL templates* for production of human-readable versions of OSCAL XML content
- *CSS*, so people who are developing catalogs and profiles using XML tools can use CSS for data entry, which offers a much more usable interface
- *Documentation* to define the OSCAL component models, capture the operational model of how to use OSCAL, and explain how you can convert existing content (catalogs, profiles, etc.) into OSCAL formats
The OSCAL project is producing several types of deliverables, organized into several GitHub repositories as explained [in the project page](https://pages.nist.gov/OSCAL/about/projects/).

Contributions are welcome in any of these areas. For information on the project's current needs and priorities, see the project's GitHub issue tracker (discussed below). Please refer to the [guide on how to contribute to open source](https://opensource.guide/how-to-contribute/) for general information on contributing to an open source project.

Expand Down Expand Up @@ -73,7 +68,7 @@ The OSCAL project uses a typical GitHub fork and pull request [workflow](https:/
1. Create a feature branch from the main branch for making changes. You can [create a branch in your personal repository](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/) directly on GitHub or create the branch using a Git client. For example, the ```git branch working``` command can be used to create a branch named *working*.
1. You will need to make your modifications by adding, removing, and changing the content in the branch, then staging your changes using the ```git add``` and ```git rm``` commands.
1. Once you have staged your changes, you will need to commit them. When committing, you will need to include a commit message. The commit message should describe the nature of your changes (e.g., added new feature X which supports Y). You can also reference an issue from the OSCAL repository by using the hash symbol. For example, to reference issue #34, you would include the text "#34". The full command would be: ```git commit -m "added new feature X which supports Y addressing issue #34"```.
1. Next, you must push your changes to your personal repo. You can do this with the command: ```git push```.
1. Next, you must push your changes to your personal fork repo if you are individual community contributor, or optionally from this repository directly if you are a staff member on the NIST OSCAL Team. You can do this with the command: ```git push```.
1. Finally, you can [create a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/).
- Please allow the NIST OSCAL maintainers to make changes to your pull request, to efficiently merge it, by selecting on your fork the setting to [always allow edits from the maintainers](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork).
- Review [the OSCAL release and versioning strategy](./versioning-and-branching.md) and [choose the base branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-base-branch-of-a-pull-request) accordingly. Normally, you should target the `develop` branch or a `release-x.y` as the base branch unless asked to use a different branch. Please select the appropriate branch before requesting a review from a maintainer so delays in approving your pull request are avoided.
Expand Down
2 changes: 2 additions & 0 deletions versioning-and-branching.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ git remote add upstream [email protected]:usnistgov/OSCAL.git

## Personal Working Branches

Staff on the NIST OSCAL Team can do work on branches in this repository or choose to do work as an individual outside contributor in a fork as described below.

All individual work will be done in branches in a personal fork of this repository.

Personal branches should be named using the convention `<issue #>-brief-dashed-name`.
Expand Down

0 comments on commit 6374f41

Please sign in to comment.