首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

全新版FRIDA与安卓 应用安全与逆向实战宝典二月二日江上行

全新版FRIDA与安卓 应用安全与逆向实战宝典二月二日江上行

download:https://www.51xuebc.com/thread-595-1-1.html

编写pull request

Pull requests(PRs)是任何项目的根本面。它们是代码检查的中心。假如没有好的描绘,代码检查很快就会成为团队性能的瓶颈。

一个好的PR描绘总结了正在停止的更改以及为什么停止这些更改。大型项目通常有一个拉取恳求模板

## Proposed changes

Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request.

## Types of changes

What types of changes does your code introduce to Appium?

- [ ] Bugfix (non-breaking change which fixes an issue)

- [ ] New feature (non-breaking change which adds functionality)

- ...

## Checklist

- [ ] I have read the CONTRIBUTING doc

- [ ] I have signed the CLA

- [ ] Lint and unit tests pass locally with my changes

## Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc…

防止含糊的PR标题

请防止下面这些标题:

Fix build.

Fix bug.

Add patch.

这些以至没有尝试描绘我们正在处置的构建、错误或补丁是什么。关于构建的哪个局部停止了修复、哪个错误被处理,或者添加了哪个补丁,略微提供一些额外的细节能够大大促进与同事之间更好的沟通和协作。它能够使人们达成共识并站在同一个起点上。

Pull Request 标题通常运用祈使语态书写。它们是整个 Pull Request 的单行摘要,并应描绘 Pull Request 所做的工作。

以下是一些好的示例:

Support custom srcset attributes in NgOptimizedImage

Default image config to 75% image quality

Add explicit selectors for all built-in ControlValueAccessors

防止冗余的PR

一个大的PR意味着一个宏大的描绘,没有人愿意检查成百上千行的代码,有时只是为了最终驳回整个代码!

相反,你应该:

与你的团队经过 Issues 停止沟通,

制定方案,

将问题合成成较小的局部,

或者每个局部都有本人的 PR 。

如今是不是洁净了许多?

在PR正文中提供细节

与 PR 标题不同,PR 正文是包含一切细节的中央,包括:

为什么要停止这个 PR?

为什么这是最佳办法?

该办法任何缺乏之处,以及处理计划

相关的 bug 或跟踪单号,基准测试结果等等。

报告bug

Bug 报告是任何项目中最重要的方面之一。一切优秀的项目都树立在用户反应的根底上。通常来说,在无数次测试之后,依然是用户发现了大局部 Bug。用户也是巨大的理想主义者,有时他们会提出功用方面的想法,请倾听他们的意见!

关于技术项目,一切这些都是经过报告 issue 来完成的。一个写得好的 issue 能够让另一个开发人员轻松地找到问题并停止回应。

比方,大多数大型项目都有一个

### Subject of the issue

Describe your issue here.

### Your environment

* version of angular-translate

* version of angular

* which browser and its version

### Steps to reproduce

Tell us how to reproduce this issue.

### Expected behavior

Tell us what should happen.

### Actual behavior

Tell us what happens instead.

搜集截图

假如是 CLI 程序的截图,请确保文本明晰可见。假如是 UI 程序,请确保截图捕捉到正确的元素和状态。

你可能需求捕获一个实践的交互过程来展现问题。假如是这种状况,请尝试运用屏幕录制工具来录制 GIF 动画。

如何重现问题

当 Bug 在程序员的电脑上呈现时,处理起来要容易得多。这就是为什么一个好的提交信息应该附带可以准确重现问题的步骤。

下面是一个例子:

Update: you can actually reproduce this error with objects:

export class OneComponent {

obj = ;

objs = [this.obj, this.obj, this.obj, this.obj];

setObj(i: number, value: string) {

this.objs[i] = ;

}

}

The bug is reproducible as long as the trackBy function returns the same value for any two entries in the array. So weird behavior can occur with any duplicate values.

倡议缘由

作为捕获 Bug 的人,你能够为为何呈现这个 Bug 提供一些潜在的缘由。或许 Bug 只在遇到某个特定事情后发作,或者只在挪动设备上发作。

探究源码也没有什么害处,或许能够找出招致问题的缘由。然后,你的 issue 会更快地被关闭,而且你有可能被分配到相关的PR。

与客户沟通

你可能是一名独立的自在职业者,或者可能是一个小团队里的主要开发人员。在任何一种状况下,假定你担任与客户在项目上停止沟通。

现往常,程序员的呆板印象是我们不擅长沟通。我们以过于技术化的术语表达本人,通知他人什么是可能的,什么是不可能的,以至当有人质疑我们的办法时,我们会变得有防御性。

那么,如何缓解这种呆板印象?讯问客户想要什么,并一直听取他们的反应。以下是如何做到这一点的办法。

讯问正确的问题

首先要确保你和客户的想法是分歧的:

您的目的受众是谁?

网站的目的是什么?

您最近的竞争对手是谁,他们做对了什么?

发问也是以积极的方式写作的好办法,特别是不同意客户的反应或决策的状况下。发问迫使对方支持本人的主张,而不是经过为本人的立场辩护来攻击他们:

您对此能否称心,即便它带来额外的性能本钱?

挪动组件能否有助于更好地完成我们的目的?

太好了,谁担任在启动后维护它?

您晓得这两种颜色之间的比照能否契合 WCAG AA 规范吗?

采购本人

假如你要向潜在的客户停止采购,你就需求压服他们雇用你。客户为什么应该选择你?提出以下内容很重要:

你是谁

你在做什么

为什么你很合适这份工作?

你所做过的相关工作的链接

一旦你得到了工作并需求起草合同,请记住没有比一堆法律术语更令人生畏的内容了。即便它是为设计项目编写的

你对细节的关注可能是你和其他开发者赢取同一项目的区别。依据我的经历,客户容易雇用他们以为会喜欢与之协作的开发者,而不是技术上最有才能或经历最丰厚的开发者。

编写微文案

微文案是编写用户友好的UI信息的一门艺术,例如错误音讯。我敢打赌,作为开发人员,你有时不得不编写错误音讯,由于它们不断被放置到发布时间。

这可能就是为什么我们有时会看到这样的错误:

Error: Unexpected input (Code 693)

错误是你最不希望用户遇到的问题。但它们的确会发作,我们无能为力。以下是一些进步微文案技艺的技巧。

防止技术术语

大多数人不晓得什么是效劳器,而程序员100%晓得。这就是为什么在错误音讯中会看到像 API 或超时执行这样的不常见术语。

除非你面对的是技术客户或用户群体,否则你的大局部用户可能没有上过计算机科学课程,不晓得互联网是如何工作的,也不晓得为什么某个特定的东西不起作用。

因而,一个好的错误音讯不应该解释为什么呈现问题,由于这样的解释可能需求运用令人生畏的技术术语。这就是为什么防止运用技术术语十分重要。

不要责怪用户

想象一下:我正在尝试登录你的平台。我翻开阅读器,访问你的网站,输入我的细致信息。然后我被告知:“您的电子邮件/密码不正确。”

虽然以为这个信息是敌对的似乎很夸大,但它在潜认识里让我觉得本人很愚笨。微文案表示,千万不要责怪用户。尝试将你的音讯更改为责备性更少的内容,例如:“负疚,该电子邮件密码组合不正确。我们能够协助您恢复帐户。”

我还想补充一点,防止运用全大写字母和感慨号十分重要!当然,它们能够用来传达兴奋的心情,但在微文案中运用会给用户带来一种敌对感。

不要让用户手足无措

在微文案中运用诙谐是个好主见!它能够缓解心情,是减少负面影响的简双方法。

但是,假如你运用不当,诙谐也有可能会让用户感到蔑视和凌辱。这是一个宏大的风险。

不要不顾一切地去开玩笑 - 强行诙谐可能比不诙谐更糟糕。假如你不肯定,请坚持耿直的表情。

编写无障碍标志

我们能够轻松地撰写一篇关于无障碍性,以及与技术写作相关的文章。事实上,无障碍性通常包含在内容款式指南中

作为开发者,你可能曾经十分理解无障碍性。你以至可能是很勤奋的开发者之一,将无障碍性作为工作流程的中心局部。但是,无论我们觉得无障碍性是多么重要,无障碍性依然是低优先级。

因而,假如你发现本人正在将别人的文案编写到代码中,为其他开发者编写文档,以至本人编写UI文案,要留意一些根本的无障碍最佳理论,由于它们完善了一切其他技术写作的倡议。

一些需求留意的事项包括:

尽可能运用语义标签(例如

等)

遵照逻辑的标题构造

为图片添加 alt 文本

留意行内语义

总结

这些是展现技术写作和开发互相关联的六种方式。固然这些例子和倡议可能不是什么深邃的技术,但我希望你可以发现它们有用,无论是与其他开发人员协作、维护本人的工作、在紧急状况下编写本人的副本,或者起草项目提案等等。

  • 发表于:
  • 原文链接https://page.om.qq.com/page/OSVqEHwC5MUMui0SEF71qpug0
  • 腾讯「腾讯云开发者社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。
  • 如有侵权,请联系 cloudcommunity@tencent.com 删除。

扫码

添加站长 进交流群

领取专属 10元无门槛券

私享最新 技术干货

扫码加入开发者社群
领券