如何用Intellij IDEA优雅的在GitHub开源项目

来源:互联网 发布:淘宝上可以卖中药吗 编辑:程序博客网 时间:2024/06/04 20:12

背景

最近在尝试独立做个中型(大概)项目,想着把项目放GayHub上弄得规范点儿,方便以后其他有需要的人(应该不会有)。但在用Intellij IDEA分享工程时总是会有小问题,不能忍啊!
于是哼哧哼哧花俩小时终于搞定了╮(╯_╰)╭

解决方案

  1. 先在本地创建好项目,再使用IDEA自带的Share Project On GitHub 实现上传,最后在GayHub上配置到相关信息 。推荐
  2. 先创建远程仓库并配置好相关信息,再Clone到本地添加相关工程。不推荐,容易出现小问题

在这里记录下方案一的实现方法。
注意,在Intellij idea操作的某些步骤可能需要Ultimate版本!

解决步骤

安装.Ignore插件

  1. 打开IDEA的File->Settings->Plugins->Browse Repositories。在打开的窗口中找到.Ignore插件,如图所示。
    插件安装

    点击右边说明栏中绿色的Install(我已经装过了,所以没有)。

  2. 安装完毕后重启Intellij IDEA,插件更新完毕。

配置新工程

  1. 创建工程
    这里以Android项目为例
    创建好的工程目录结构
    工程目录

    可以看到已经包含了两个.ignore文件了,这些默认的忽略文件已经基本可以满足需要,也可以删掉按照需求自己添加。

  2. 添加.ignore文件
    先把原先的.gitignore删掉,在需要添加忽略文件的目录上,右键->.ignore file->根据需要选择对应的忽略文件,这里是.gitIgnore
    选择忽略文件

    选择模板,这里可以使用自定义的User Template,也可以选择预置的模板,我这里选择了Android + Gradle(也可以再加上JetBrains ,不过我加上后重复的忽略项目较多)。
    配置Template

    选择好后,点击Generate生成忽略文件,像我一样的强迫症可以浏览下把重复的项目删掉(笑)。
    生成忽略文件

  3. 上传到GitHub仓库
    选择VCS->Import into Version Control->Share Project On GitHub,第一次使用会要求登录。

    输入仓库名称、主分支名称和Description。比如
    配置仓库信息

    注意,Description是你的工程名称!所以不能换行╮(╯_╰)╭

    输入好后,没什么问题就可以点击Share进行分享,一切顺利的话(取决于是否翻墙)半分钟内就可以创建仓库成功。

    仓库建好后,会提示Commit项目了,因为我们添加了.gitIgnore,所以直接OK,接下就是等待项目上载完成。
    Commit项目

    上传成功,打开GayHub,项目已经上线啦~
    项目上传成功

    注意,有时IDEA会提示你添加某某文件,一般直接点OK就可以。

配置远程仓库

  1. 添加README
    一个逼格够高的项目必备的文件,可以让项目变得像是除了我还会有人Contribute一样╮(╯_╰)╭。
    点击Add a README点击按钮

    在里面写些想说的话。
    输入信息

    拉到最下方选择Commit new file,搞定~
    添加成功

  2. 添加LICENSE
    一个逼格更高的文件,可以让你有一种你的劳动会被人引用到商业项目的幻觉。
    点击Create new file,输入LICENSE.md,然后直接保存该文件。
    创建文件

    再重新打开编辑
    重新编辑文件

    旁边就会出现选择开源协议的选项,挑一个好看的选就行(严谨的话还是得看看协议相关内容)。
    选择开源协议
    选好后再次Commit,完成!

后记

没啥好记的,说说感想,在这个云端办公的时代我连传个项目都不利索,也是没谁了啊。可能还是懒癌+薄脸皮作祟,毕竟把项目放到云端有时候也没啥用,还(可能)得被人看写的丢人代码,想想就尴尬~╮(╯_╰)╭

原创粉丝点击