| 
									
										
										
										
											2014-02-07 10:53:40 +00:00
										 |  |  | # Contributing
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | The SheetJS Libraries should be free and clear to use in your projects.  In | 
					
						
							|  |  |  | order to maintain that, every contributor must be vigilant. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | There have been many projects in the past that have been very lax regarding | 
					
						
							|  |  |  | licensing, and we are of the opinion that those are ticking timebombs and that | 
					
						
							| 
									
										
										
										
											2015-04-02 20:32:22 +00:00
										 |  |  | no commercial product should depend on them. | 
					
						
							| 
									
										
										
										
											2014-02-07 10:53:40 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | # Required Reading
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | These are pretty short reads and emphasize the importance of proper licensing: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | - https://github.com/kennethreitz/tablib/issues/114 (discussion of other tools) | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | - http://www.codinghorror.com/blog/2007/04/pick-a-license-any-license.html | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-04-02 20:32:22 +00:00
										 |  |  | # Raising Issues
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Issues should generally be accompanied by test files.  Since github does not | 
					
						
							|  |  |  | support attachments, the best method is to send files to <sheetjs@gmail.com> | 
					
						
							|  |  |  | (subject line should contain issue number or message) or to share using some | 
					
						
							|  |  |  | storage service.  Unless expressly permitted, any attachments will not be | 
					
						
							|  |  |  | shared or included in a test suite (although I will ask :) | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | If sending email to a gmail account is problematic, the <dev@sheetjs.com> email | 
					
						
							|  |  |  | inbox is self-hosted. | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-06-12 21:37:07 +00:00
										 |  |  | # Opening Pull Requests
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Before opening a pull request, [squash all commits into  | 
					
						
							|  |  |  | one](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History). If the pull  | 
					
						
							|  |  |  | request addresses documentation or demos, add `[ci skip]` in the body or title  | 
					
						
							|  |  |  | of your commit message to skip Travis checks. | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2014-02-07 10:53:40 +00:00
										 |  |  | # Pre-Contribution Checklist
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Before thinking about contributing, make sure that: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | - You are not, nor have ever been, an employee of Microsoft Corporation. | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2014-05-16 00:33:34 +00:00
										 |  |  | - You have not signed any NDAs or Shared Source Agreements with Microsoft | 
					
						
							| 
									
										
										
										
											2014-02-07 10:53:40 +00:00
										 |  |  |   Corporation or a subsidiary | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | - You have not consulted any existing relevant codebase (if you have, please | 
					
						
							| 
									
										
										
										
											2015-04-02 20:32:22 +00:00
										 |  |  |   take note of which codebases were consulted). | 
					
						
							| 
									
										
										
										
											2014-02-07 10:53:40 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | If you cannot attest to each of these items, the best approach is to raise an | 
					
						
							|  |  |  | issue.  If it is a particularly high-priority issue, please drop an email to | 
					
						
							|  |  |  | <sheetjs@gmail.com> and it will be prioritized. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | # Intra-Contribution
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Keep these in mind as you work: | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | - Your contributions are your original work.  Take note of any resources you | 
					
						
							|  |  |  |   consult in the process (and be extra careful not to use unlicensed code on | 
					
						
							|  |  |  |   the internet. | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2014-05-16 00:33:34 +00:00
										 |  |  | - You are working on your own time.  Unless they explicitly grant permission, | 
					
						
							| 
									
										
										
										
											2014-02-07 10:53:40 +00:00
										 |  |  |   your employer may be the ultimate owner of your IP | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2014-05-16 00:33:34 +00:00
										 |  |  | # Post-Contribution
 | 
					
						
							| 
									
										
										
										
											2014-02-07 10:53:40 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | Before contributions are merged, you will receive an email (at the address | 
					
						
							|  |  |  | associated with the git commit) and will be asked to confirm the aforementioned | 
					
						
							| 
									
										
										
										
											2019-09-28 12:24:33 +00:00
										 |  |  | items.  Ensure that the email addresses associated with the commits are valid. |