IEEE.org     |     IEEE Xplore Digital Library     |     IEEE Standards     |     IEEE Spectrum     |     More Sites

Commit 26f1b409 authored by Joshua Gay's avatar Joshua Gay 🙀
Browse files

Fixes formatting and minor edits on CONTRIBUTING_example.md

parent ac29a3ec
......@@ -34,14 +34,16 @@ We greatly appreciate it if your merge request met the following criteria
Please use the following workflow when submitting merge requests:
1. Fork our project into your personal namespace (or group)
1. Create a feature branch in your fork (if possible include the title of the issue or the issue number that the merge request corresponds to)
1. Write any appropriate continuous integration tests.
1. Please squash commits into a small number of logically organized commits, keeping the commit history intact on shared branches
1. Push the commit(s) to your working branch in your fork.
1. Submit a merge request (MR) to our projects default branch
2. Create a feature branch in your fork (if possible include the title of the issue or the issue number that the merge request corresponds to)
3. Write any appropriate continuous integration tests.
4. Push the commit(s) to your working branch in your fork.
- Squash commits into a small number of logically organized commits, keeping the commit history intact on shared branches
- please try to have fewer than 15 commit messages per merge request
5. Submit a merge request (MR) to our projects default branch
- merge request title should describe the change you wish to make
- merge request descriptoin should give the reason for the chnage
1. please try to have fewer than 15 commit messages per merge request
- merge request descriptoin should give the reason for the change
- use complete URLs to issues and other MR, milestone, etc
- include the complete path when referencing files within this repository (no URL required)
## Merge request acceptance criteria
......@@ -49,7 +51,7 @@ Your merge request needs at least 1 approval, but depending on your change you m
### Commit messages guidelines
Please follow Chris Beams seven rules for writing a good commit messages:
Please follow Chris Beam's seven rules for writing a good commit messages:
> 1. Separate subject from body with a blank line
> 2. Limit the subject line to 50 characters
......@@ -59,12 +61,13 @@ Please follow Chris Beams seven rules for writing a good commit messages:
> 6. Wrap the body at 72 characters
> 7. Use the body to explain what and why vs. how
For examples and additional explanation please read Chris's article:
For examples and additional explanation of these seven rules, please read Chris Beam's blog post:
<https://chris.beams.io/posts/git-commit/>.
**In addition, we ask that you also:**
* Use full urls to issues and merge requests (no short references, please)
* Use full urls to issues and merge requests (no short references, please)
* include the complete path when referencing files in your commit message body
* Do not inlcude emoji in commit messages
## FIXME: Communicating with us
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment