Skip to content

Latest commit

 

History

History
57 lines (44 loc) · 3.48 KB

CONTRIBUTING.md

File metadata and controls

57 lines (44 loc) · 3.48 KB
Raw

How to contribute?

Notes:

  • Regarding fixing of a typo in existing cheat sheet, you can directly create a Pull Request otherwise follow the process below.
  • ❗ Focus on updating a single file by Pull Request to facilitate the review by the core team.
  • ⚠️ Pull Request marked as WAITING_UPDATE (indicate that the core team wait an update from the author of the Pull Request) that do not receive any update from the author in a timeframe superior to one month then will be closed.
  • ⚠️ If the assignees of an issue do not provide any Pull Request in a timeframe superior to one month then the issue will go back to the HELP_WANTED state and assignees will be removed.

Follow these steps:

  1. Create an new Issue using either:
    • The new_cheatsheet_proposal template if you want to propose a new cheat sheet.
    • The update_cheatsheet_proposal template if you want to modify a existing cheat sheet.
  2. After a discussion on the topic/update and if the proposal is accepted by the project leaders then:
    1. Clone this GitHub repository.
    2. Either:
    • Create the cheat sheet using the dedicated template in case of a new cheat sheet.
    • Modify the target cheat sheet in case of a update/refactoring.
    1. Submit your Pull Request.
    2. Verify that the CI job applied on your Pull Request do not fail!

How to setup my contributor environment?

Follow these steps:

  1. Install Visual Studio Code (named VSCode from here), it is cross platform and free.
  2. Install this plugin from VSCode.
  3. Open the file Project.code-workspace from VSCode via the menu File > Open Workspace....
  4. You are ready to contribute 👍

⏰ Before to push my update to my fork, what I need to verify?

  1. Ensure that the markdown file you have created/modified do not have any warnings/errors raised by the linter, you can see it in this bottom bar when the markdown file is opened in VSCode:

PluginWarningUI

  1. Ensure that the markdown file you have created/modified do not have any deadlinks. You can verify that by using this plugin, if you cannot use this plugin then, at least, verify that all the links are valid before to push:
    1. Install NodeJS to install NPM.
    2. Install the validation plugin via the command npm install -g markdown-link-check
    3. Use this command (from the repository root folder) on your markdown file to verify the presence of any deadlinks:
$ markdown-link-check -c .markdownlinkcheck.json [MD_FILE]

See the example below:

$ markdown-link-check -c .markdownlinkcheck.json cheatsheets/Transaction_Authorization_Cheat_Sheet.md
FILE: cheatsheets/Transaction_Authorization_Cheat_Sheet.md
[✓] https://en.wikipedia.org/wiki/Time-based_One-time_Password_Algorithm
[✓] https://en.wikipedia.org/wiki/Chip_Authentication_Program
[✓] http://www.cl.cam.ac.uk/~sjm217/papers/fc09optimised.pdf
...
# If the program do not say to you that you have deadlinks so it's OK
# The identified deadlinks are showed using a red cross instead of a green tick before the link.