Skip to content

Latest commit

 

History

History
95 lines (61 loc) · 4.33 KB

CONTRIBUTING.md

File metadata and controls

95 lines (61 loc) · 4.33 KB
Raw

Contributing

This document applies during 2021 and may change at a future date.

Introduction

The current status of the ASVS project is as follows:

The ASVS project is planning to release a 5.0 version during 2022 which will be a significant modification, similar to the scale of changes which happened during 4.0.

We will try, on a best efforts basis, to address issues and push changes to the "bleeding edge", master branch. For as long as possible, we will make changes to this branch without altering current numbering and wherever possible we will push minor, non-breaking changes to a 4.0.3 branch which may or may not be formally released.

How to make changes to the bleeding edge during this period

To help those who are using the "bleeding edge" version for their tests and in order to be able to track changes made during this period, we have prepared a set of labels to be used when making changes to the "bleeding edge" version during this time. If there is enough content to make a 4.0.3 or 4.1 release, this will also make it easier to get an overview of changes in place

Standard for changes

Keep all current numbers

  • New requirements must be placed at the end of sub-category
  • Deleted requirements must keep "placeholder" to avoid some other requirements to be added/moved to that number, examples:
| **1.2.1** | [MOVED TO 1.14.7] | | | | |

| **5.5.1** | [DELETED] | | | | |

Use tags to describe the change

The following tags should be added to any modified requirement as appropriate. These tags should all be relative to how the requirement appeared in v4.0.2.

  • [ADDED] - New requirement (should only be added at the end of a sub-section.)
  • [ADDED, SPLIT FROM x.y.z] - New requirement which was previously part of another requirement
  • [MODIFIED] - Requirement description has been modified
  • [MOVED FROM x.y.z] - Requirement has been moved to a different sub-section but not modified. (should only be added at the end of a sub-section.)
  • [MODIFIED, MOVED FROM x.y.z] - Requirement description has been modified and requirement has been moved to a different sub-section.
  • [MOVED TO x.y.z] - Placeholder to keep number, requirement has been moved to another category (but not modified).
  • [DELETED] - Placeholder to keep number, requirement has been deleted
  • [DELETED, MERGED TO x.y.z] - Placeholder to keep number, requirement has been merged into another requirement, e.g. to solve a duplicate
  • [LEVEL L1 > L2] - Requirement's level has changed

CWE and/or NIST mapping changes do not require labels.

Tags must be placed before verification description, example:

| **12.4.2** | [MODIFIED] Verify that files obtained from untrusted sources are scanned by antivirus scanners to prevent upload and serving of known malicious content. | ✓ | ✓ | ✓ | 509 |

Translations

We are also actively looking for translations of the 4.n branch!

If you are interested in creating a translation, here are some pointers for how you can help us:

  • Please first of all search the repository to see if there is already a translation for your proposed language. We currently have completed or in-progress translations in the following languages (but please search anyway in case this list is superceeded!):
    • German
    • French
    • Spanish
    • Persian
    • Turkish
    • Japanese
  • If the language you are interested in appears, it would be great if you could reach out to the translator to see if you can help them. Often there is work to do in creating markdown files or updating the translation to keep it up to date with latest changes.
  • We would recommend basing your translation either on the v4.0.2 branch or on the bleeding edge branch. When you submit a pull request with your translation, please be clear about which version you have targeted.
  • Please duplicate the existing markdown files, create a new folder for your language underneath the 4.0 folder and create the translated markdown files there.
  • If you are targeting the bleeding edge, please try and monitor changes and update your translation accordingly.

Thanks!!