Skip to content

Commit

Permalink
Update documentation in 2 places: new security team and setting up in…
Browse files Browse the repository at this point in the history
…itial nvda development git repo (#16091)

Closes issue number: #16088

# Summary of the issue / description of user facing changes

This PR is to update the documentation in 2 places:
* include information on the NVDA security team
* for consistency, show the git clone command explicity when initially creating your nvda environment

Code Review Checklist:
No code changes.

Commits:
* Added additional content to docs
* Added forking before cloning
* Moved comments to text
  • Loading branch information
gerald-hartig authored Jan 24, 2024
1 parent 3d64cf9 commit dc23f9c
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
9 changes: 7 additions & 2 deletions projectDocs/dev/createDevEnvironment.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,14 @@ The NVDA project uses the [git](https://www.git-scm.com/) version control system

The NVDA repository is located at https://github.com/nvaccess/nvda.

If you plan on contributing to NVDA, you should [fork and clone](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repository.
If you plan on contributing to NVDA, you will need to [fork and clone](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repository.

After forking the repository into your user account (`YOUR-USERNAME`), clone with `--recursive` to fetch all required submodules.

```sh
git clone --recursive https://github.com/YOUR-USERNAME/nvda.git
```

Use the `--recursive` option when performing `git clone` to fetch the required git submodules we use.

### Keeping the fork in sync
When you fork the repository, GitHub will create a copy of the master branch.
Expand Down
13 changes: 13 additions & 0 deletions security.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,16 @@ This information will help us triage your report more quickly.
* If there is a known solution or approach to fixing this issue

Examples of handled security issues in NVDA can be found in the [NVDA GitHub Security Advisories page](https://github.com/nvaccess/nvda/security/advisories).

## Security Advisory Group

NV Access is committed to maintaining the highest standards of security in NVDA. In line with this commitment, we have established a Security Advisory Group. This group plays a pivotal role in enhancing the security of NVDA.

Objectives and Functioning:

* The group is composed of dedicated users and security enthusiasts who volunteer their expertise.
* It focuses on identifying, analysing and resolving security issues in a collaborative manner.
* The group's contributions are instrumental in maintaining and elevating our security standards.
* Their insights and recommendations are directly incorporated into our development process, leading to more secure and reliable software.

We welcome participation from our user community. If you have a keen interest in security and wish to contribute, please [contact us](mailto:[email protected]]).

0 comments on commit dc23f9c

Please sign in to comment.