mirror of
https://github.com/codeigniter4/CodeIgniter4.git
synced 2025-02-20 11:44:28 +08:00
docs: change MD heading style
This commit is contained in:
parent
797aa725d9
commit
07cc1ea12c
@ -1,5 +1,4 @@
|
||||
Developer's Certificate of Origin 1.1
|
||||
=====================================
|
||||
# Developer's Certificate of Origin 1.1
|
||||
|
||||
By making a contribution to this project, I certify that:
|
||||
|
||||
|
@ -1,5 +1,4 @@
|
||||
Contributing to CodeIgniter
|
||||
===========================
|
||||
# Contributing to CodeIgniter
|
||||
|
||||
CodeIgniter is a community driven project and accepts contributions of
|
||||
code and documentation from the community. These contributions are made
|
||||
|
@ -1,12 +1,10 @@
|
||||
Contribution CSS
|
||||
================
|
||||
# Contribution CSS
|
||||
|
||||
CodeIgniter uses SASS to generate the debug toolbar's CSS. Therefore,
|
||||
you will need to install it first. You can find further instructions on
|
||||
the official website: <https://sass-lang.com/install>
|
||||
|
||||
Compile SASS files
|
||||
------------------
|
||||
## Compile SASS files
|
||||
|
||||
Open your terminal, and navigate to CodeIgniter's root folder. To
|
||||
generate the CSS file, use the following command:
|
||||
@ -20,8 +18,7 @@ this prevents a "cache" folder from being created
|
||||
- `admin/css/debug-toolbar/toolbar.scss` is the SASS source
|
||||
- `system/Debug/Toolbar/Views/toolbar.css` is he CSS destination
|
||||
|
||||
Color scheme
|
||||
------------
|
||||
## Color scheme
|
||||
|
||||
**Themes**
|
||||
|
||||
|
@ -1,5 +1,4 @@
|
||||
Contribution Signing
|
||||
====================
|
||||
# Contribution Signing
|
||||
|
||||
We ask that contributions have code commits signed. **This is important
|
||||
in order to prove, as best we can, the provenance of contributions.**
|
||||
@ -28,8 +27,7 @@ performs an important role, we will insist that it be securely signed.
|
||||
|
||||
Read below to find out how to sign your commits :)
|
||||
|
||||
Secure Signing
|
||||
--------------
|
||||
## Secure Signing
|
||||
|
||||
To verify your commits, you will need to setup a GPG key, and attach it
|
||||
to your GitHub account.
|
||||
@ -57,8 +55,7 @@ The basic steps are
|
||||
Depending on your IDE, you may have to do your Git commits from your Git
|
||||
bash shell to use the **-S** option to force the secure signing.
|
||||
|
||||
Commit Messages
|
||||
---------------
|
||||
## Commit Messages
|
||||
|
||||
Regardless of how you sign a commit, commit messages are important too.
|
||||
They communicate the intent of a specific change, concisely. They make
|
||||
|
@ -1,5 +1,4 @@
|
||||
Contribution Workflow
|
||||
=====================
|
||||
# Contribution Workflow
|
||||
|
||||
Much of the workflow for contributing to CodeIgniter (or any project)
|
||||
involves understanding how [Git](https://git-scm.com/) is used to manage
|
||||
@ -15,8 +14,7 @@ values for when you try these:
|
||||
ORIGIN_URL // the cloning URL for your repository fork
|
||||
UPSTREAM_URL // the cloning URL for the CodeIgniter4 repository
|
||||
|
||||
Branching
|
||||
---------
|
||||
## Branching
|
||||
|
||||
CodeIgniter uses the
|
||||
[Git-Flow](http://nvie.com/posts/a-successful-git-branching-model/)
|
||||
@ -38,8 +36,7 @@ but disagree with Y, meaning we cannot merge the request. Using the
|
||||
Git-Flow branching model you can create new branches for both of these
|
||||
features and send two requests.
|
||||
|
||||
Forking
|
||||
-------
|
||||
## Forking
|
||||
|
||||
You work with a fork of the CodeIgniter4 repository. This is a copy of
|
||||
our repository, in your GitHub account. You can make changes to your
|
||||
@ -52,8 +49,7 @@ repository](https://github.com/codeigniter4/CodeIgniter4), click the
|
||||
**Fork** button in the top-right of the page, and choose which account
|
||||
or organization of yours should contain that fork.
|
||||
|
||||
Cloning
|
||||
-------
|
||||
## Cloning
|
||||
|
||||
You *could* work on your repository using GitHub's web interface, but
|
||||
that is awkward. Most developers will clone their repository to their
|
||||
@ -68,8 +64,7 @@ Clone your repository, leaving a local folder for you to work with:
|
||||
cd ALL_PROJECTS
|
||||
git clone ORIGIN_URL
|
||||
|
||||
Syncing develop
|
||||
----------------
|
||||
## Syncing develop
|
||||
|
||||
Within your local repository, Git will have created an alias,
|
||||
**origin**, for the GitHub repository it is bound to. You want to create
|
||||
@ -99,8 +94,7 @@ precedence, even if it causes problems for other contributions.
|
||||
It is a good idea to synchronize repositories when the shared one
|
||||
changes.
|
||||
|
||||
Branching Revisited
|
||||
-------------------
|
||||
## Branching Revisited
|
||||
|
||||
The top of this page talked about the **master** and **develop**
|
||||
branches. The *best practice* for your work is to create a *feature
|
||||
@ -120,8 +114,7 @@ creating:
|
||||
|
||||
Saving changes only updates your local working area.
|
||||
|
||||
Committing
|
||||
----------
|
||||
## Committing
|
||||
|
||||
Your local changes need to be *committed* to save them in your local
|
||||
repository. This is where [contribution signing](./signing.md) comes
|
||||
@ -153,8 +146,7 @@ a starting point for your next session working with your repository.
|
||||
This is a good practice, as it is not always obvious which branch you
|
||||
are working in.
|
||||
|
||||
Pushing Your Branch
|
||||
-------------------
|
||||
## Pushing Your Branch
|
||||
|
||||
At some point, you will decide that your feature branch is complete, or
|
||||
that it could benefit from a review by fellow developers.
|
||||
@ -180,8 +172,7 @@ And finally push your local branch to your GitHub repository:
|
||||
|
||||
git push --force origin new/mind-reader
|
||||
|
||||
Pull Requests
|
||||
-------------
|
||||
## Pull Requests
|
||||
|
||||
On GitHub, you propose your changes one feature branch at a time, by
|
||||
switching to the branch you wish to contribute, and then clicking on
|
||||
@ -212,8 +203,7 @@ If your PR does not follow our contribution guidelines, or is
|
||||
incomplete, the codebase maintainers will comment on it, pointing out
|
||||
what needs fixing.
|
||||
|
||||
Cleanup
|
||||
-------
|
||||
## Cleanup
|
||||
|
||||
If your PR is accepted and merged into the shared repository, you can
|
||||
delete that branch in your GitHub repository as well as locally.
|
||||
|
Loading…
x
Reference in New Issue
Block a user