docs

mlabbe · Aug 6, 2016 · e801856 · e801856
1 parent 5619b52
commit e801856
Showing 1 changed file with 8 additions and 6 deletions.
diff --git a/docs/submitting_pull_requests.md b/docs/submitting_pull_requests.md
@@ -4,17 +4,19 @@ I have had to turn away a number of pull requests due to avoidable circumstances
 
 Here are the rules:
 
-- *Submit pull requests to the devel branch*. The library must be tested on every compiler and OS, so there is no way I am going to just put your change in the master before it has been sync'd and tested on a number of machines. Master branch is depended upon by hundreds of projects.
+- **Submit pull requests to the devel branch**. The library must be tested on every compiler and OS, so there is no way I am going to just put your change in the master before it has been sync'd and tested on a number of machines. Master branch is depended upon by hundreds of projects.
 
-- *Test your changes on all platforms and compilers that you can.*  Also, state which platforms you have tested your code on.  32-bit or 64-bit.  Clang or GCC.  Visual Studio or Mingw.  I have to do this to accept pull requests, so I prioritize changes that respect my time.
+- **Test your changes on all platforms and compilers that you can.**  Also, state which platforms you have tested your code on.  32-bit or 64-bit.  Clang or GCC.  Visual Studio or Mingw.  I have to test all these to accept pull requests, so I prioritize changes that respect my time.
 
-- *Submit Premake changes only*.  As of 1.1, SCons is now deprecated.  Also, do not submit altered generated projects.  I will re-run Premake to re-generate them to ensure that I can still generate the project prior to admitting your pull request.
+- **Submit Premake build changes only**.  As of 1.1, SCons is deprecated.  Also, do not submit altered generated projects.  I will re-run Premake to re-generate them to ensure that I can still generate the project prior to admitting your pull request.
 
- - *Do not alter existing behavior to support your desired behavior*. For instance, rewriting file open dialogs to behave differently, while trading off functionality for compatibility, will get you rejected.  Consider creating an additional code path.  Instead of altering `nfd_win.cpp` to support Windows XP, create `nfd_win_legacy.cpp`, which exists alongside the newer file dialog.
+- **Do not alter existing behavior to support your desired behavior**. For instance, rewriting file open dialogs to behave differently, while trading off functionality for compatibility, will get you rejected.  Consider creating an additional code path.  Instead of altering `nfd_win.cpp` to support Windows XP, create `nfd_win_legacy.cpp`, which exists alongside the newer file dialog.
 
-- *Do not submit anything I can't verify or maintain*.  If you add support for a compiler, include install instructions from scratch that you have tested yourself and work.  Accepting a pull request means I am now the maintainer of your code, so I must understand what it does and how to test it.
+- **Do not submit anything I can't verify or maintain**.  If you add support for a compiler, include from-scratch install instructions  that you have tested yourself.  Accepting a pull request means I am now the maintainer of your code, so I must understand what it does and how to test it.
 
-- *Do not change the externally facing API*.  NFD needs to maintain ABI compatibility.
+- **Do not change the externally facing API**.  NFD needs to maintain ABI compatibility.
+
+## Contact Me ##
 
 Despite all of the "do nots" above, I am happy to recieve new pull requests!  If you have any questions about style, or what I would need to accept your specific request, please contact me ahead of submitting the pull request by opening an issue on Github with your question.  I will do my best to answer you.