在github新建一个项目里需要哪些文件及作用

1.README.md文件

关于项目的介绍和使用方法。

2.  .gitignore文件

上传项目时不需要传的文件,最常用的就是“node_modules/",如下:

详细的介绍可以去git官网上看:https://git-scm.com/docs/gitignore

规则总结如下:
匹配模式前 / 代表项目根目录
匹配模式最后加 / 代表是目录
匹配模式前加 ! 代表取反

*代表任意个字符
?匹配任意一个字符
**匹配多级目录

3. 。npmignore文件

项目如果要发到npm上共别人使用,像src、test都不需要发,npm上需要bulid(或者是dist,即node打包构建出来的东西,像scr这种源码,不能执行,不用上传到npm上,test这种单元测试的也不需要)

文档:https://docs.npmjs.com/misc/developers

4. .editoreconfig 设置本项目代码书写的风格(比如空格是空2个还是4个呀,。。。)

文档:https://editorconfig.org

原文地址:https://www.cnblogs.com/kaiqinzhang/p/12000185.html

时间: 2024-10-29 08:26:57

在github新建一个项目里需要哪些文件及作用的相关文章

分针网—IT教育:nodeJS新建一个项目及代码详解

有了解nodejs的童鞋们知道,nodejs有很多的依赖,那么我们在新建一个项目的时候,如何快速的导入这些依赖从而创建一个nodejs项目呢,接下来会详细介绍. 这里安利一个前端开发工具--webstorm.真的很好用,除了有点(或许不是一点点)占内存,打开的时候有点慢.在工作中用这个会很方便(在考虑要不要写一篇前端开发工具的比较,吼吼吼~(≧▽≦)/~) ?下面我们来用命令创建一个nodejs项目. 1.我们在c盘的ws文件夹下创建项目. 打开DOS窗口,进入到ws文件夹 2.在此文件夹下创建

如何在jenkins上新建一个项目及其简单配置

1.首先,点击[新建]进入选择页面,如下图(一般选择"构建一个自由风格的软件项目")     2.填好项目名称后,点击ok,跳转至如下页面,可以在这个页面进行项目的配置(包括拉源码.修改持续构建时间.打包部署前修改配置文件等) 3.General中的"丢弃旧的构建"可以设定持续构建的 4.在"参数化构建过程"中可以设置要构建的版本有哪些,如下 5.在源码管理模块可以设置源码地址(我们公司一般用的Git) 6.如果是自动化构建,可以在构建触发器中的

vue-cli新建一个项目

零.我想把项目安装在C:\www\Arup.DAH.ABCD\SourceCode\FrontEnd这个目录下,所以在我想安装的位置,Shift+右键-->powershell窗口,打开下图位置. 一.安装vue-cli(假设已经安装node.js和npm) npm install -g vue-cli 二.新建一个项目,然后根据提示输入yes or no(文件夹名字不输入,则在当前目录下新建项目) vue init webpack ‘文件夹名字’ 三.如果上一步 "Should we r

修改项目里所包含文件的路径

当从一个项目里复制一个源文件到另一个项目时,除了修改头文件包含之外,还要用笔记本打开并修改下面两个文件中记录的源文件的路径

github新建托管项目及上传项目

一.新建托管项目 1.注册: 2.点击new repositories新建一个新项目: 3.输入项目名称及项目描述,Create repository: 4.点击右边栏的剪切板图标,记录下你的项目地址. 二.上传项目 1.下载并安装最新版本的msysgit: 2.进入到要托管的项目根目录,右键启动Git Bash命令行: 3.输入git clone接着讲先前记录下来的地址复制到后面,回车: 4.将你要传的文件拷到down下来的目录里: 5.cd directoryName(目录名称)进入到该托管

怎么让一个项目里swift与OC可以兼容混合开发?

在苹果推出了swift语言之后,很多人担心OC很快会被取代,但是苹果方面表示2年内不会摒弃OC.但现在也快了啊.有的开发团队已经开始基于swift开发,但是有很多旧的框架还没来得及用swift写出来,并且某些swift的功能你还不会写,想用OC写.因此在swift开发的程序中时不时会用到OC的类,怎么让两门语言在一个程序里无缝衔接? 其实很方便 如果你不是在董铂然博客园看到本文请 点击查看原文 如图这是一个新建的swift项目,里面直接拖入了一个SVProgressHUD框架 因为swift语言

vue - 新建一个项目

首先: 要先安装node 及 npm Node.js官方安装包及源码下载地址:http://nodejs.org/ 双击安装,在安装界面一直Next 直到Finish完成安装. 打开控制命令行程序(CMD),检查是否正常 使用淘宝NPM镜像 大家都知道国内直接使用npm 的官方镜像是非常慢的,这里推荐使用淘宝 NPM 镜像. $  npm  install  -g  cnpm  --registry=https://registry.npm.taobao.org 这样就可以使用cnpm 命令来安

新建Unity项目后包含的文件路径都是什么?

?? 创建完有一个项目后你会发现,四个不同的目录-Assets, Library, ProjectSettings, 和 Temp和几个脚本相关文件 Assets Directory:主要是所有的 C# 文件和任何其他游戏的objects,例如 3D 模型. 2D 纹理和声音的会在在此目录中的某个地方.如果文件不位于此目录中,你的游戏不能访问它. 往往当一个项目更大,它的一个好的想法是在这里有条理的创建一些子目录.这些不同的文件组织是取决于你,但大多数情况下,不同的类型在不同的目录下. 图: 你

React脚手架工程化项目里ServiceWorker.js文件作用

该文件主要涉及到离线支持和网络恢复能力 一个好的渐进式 Web 应用,不论网络状况如何都能立即加载,并且在不需要网络请求的情况下也能展示 UI (即离线时). 再次访问 http://Housing.com 渐进式 Web 应用(使用 React 和 Redux 构建)能够立即加载离线缓存的 UI. 我们可以用 Service Worker 实现这一需求.Service Worker 是一个后台 worker,可以看做是可编程的代理,允许开发者控制 request 执行其他操作.使用 Servi