Wan word text, continue to refresh my article length records, involving all aspects of front-end development. This article will be continuously updated and improved, the article some of these points may be more arbitrary or incomplete, welcome comments and additions to improve the article together. Thank you
The author has long single-handedly fighting (implying that a person on the team) at the front end of the field, he is the norm. With the expansion of the company's business, the expansion of a number of people, this time we should start thinking about collaboration and coding standards problem. This article documents some thought I collaborate in the development of front-end specifications, you also hope to bring some help.
A person walking faster, a group of people can go further, provided that a unified strategy, but also to continue to reflect and optimization.
The following is an overview of the directory, see that this is a mighty long article
1 workflow specification
1.1 Development
1.1.1 specification version
1.1.2 version control system specification
1.1.3 submit information specification
1.2 Establishing Standard
1.3 release workflow specification
1.4 Continuous Integration
1.5 Task Manager
2 technology stack specification
2.1 Technical Selection
2.2 greet new technology
3-browser compatibility specification
3.1 determine compatible strategies
3.2 determine the browser grading
3.3 to obtain statistical data
4 project organization specification
4.1 General project organizational norms
style 4.2 directory organization of
4.3 scaffolding and project templates
5 encoding specification
5.1 Javascript
5.2 HTML
5.3 CSS
5.4 code format of
5.5 master of
5.6 specific frame style guide
5.7 Code Review
6 document specification
6.1 build document Center
6.2 document format
6.3 define document templates
6.4 discussion That document
6.5 Notes That document
6.6 Code That document
7 UI design specifications
8 test specification
process 8.1 test
8.2 Unit Test
9 exception handling, monitoring and debugging Specification
9.1 exception handling
9.2 log
9.3 exception monitor
front end 10 cooperating specification
10.1 collaborative process specification
10.2 Interface Specification
10.3 Interface document specification
10.4 Interface testing and simulation
11 training / KM / precipitation technology
11.1 newcomers training
11.2 technology to create an atmosphere
12 feedback
CHANGELOG
New technology selection 2019.7.28
2019.7.29 new browser statistical data acquisition
2019.9.6 build Atmosphere in a new interview exam
What is the norm?
Specification, the term sense: that expressly or de facto standard, such as: ethics, technical specifications and so on. The verb meaning: refers to the procedure in accordance with established standards and specifications, so that an act or activity to meet or exceed the required standards, such as: standardized management, standardized operation.
Why regulate?
Reduce the cost of new members into the team, but also to a certain extent, to avoid digging
improve development efficiency, teamwork efficiency, reduce communication costs
achieved highly unified code style for easy review, on the other hand can improve the maintainability of the project
specifications are automated the basic
specification is a team of direct knowledge precipitated output
Specification contain?
The title of the article, not only refers to the front end cooperating specification 'coding standard', the front end of the specification related to all aspects of development activities, such as management of the code base, front and rear ends cooperate, code specifications, compatibility specifications;
Just inside the front teams need to collaborate, within a complete software life cycle, and we need the product / design, back-end (or native client team), testing collaboration, we need to override the content.
The following began to introduce, if I were the front end of the team Leader, I will be how to develop front-end specification that what needs to be included?
1 workflow specification
1.1 Development
1.1.1 version of the specification
item version number should be based on certain rules iteration, is recommended using semantic version of the specification, by this standard, the user can understand the impact of changes in scope version. Rules are as follows:
The major version number: When you make an incompatible API changes,
minor version number: When you do a backward compatible with new functionality,
revision number: When you do a downward compatibility problems fixed.
⬆️ Top
1.1.2 Version Control System Specification
most teams use as a git repository, manage the code it is also a science. Particularly to people of concurrent collaboration, if needed manage multiple software versions, well-defined repository management practices, can make large projects more organized, members can also improve collaboration efficiency.
Popular git branching model / workflow is git-flow, but most of the team will develop its own git workflow specification according to their own circumstances, such as a branch of the norms of our team
Git has a lot of work flow methodology, selection of these workflows may depend on the size of the structure, type of project and project team members.
For example, a simple personal project may not require complex branching division, our changes are submitted directly to the master branch;
Another example of open source projects, in addition to the core team members, other contributors authority is not submitted, but we also need some means to verify and discuss the contribution of the code is reasonable. So for the open source project fork workflow more suitable.
Learn about common workflow is conducive to the organization or to create a workflow for their team, submitted teamwork efficiency:
Simple, centralized
workflow functionality based branch of
Git Flow