| 
									
										
										
										
											2014-02-07 10:53:40 +00:00
										 |  |  | # Contributing
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-10-21 13:43:40 +00:00
										 |  |  | SheetJS CE should be free and clear to use in your projects. To ensure that | 
					
						
							|  |  |  | remains true, each contributor must be vigilant and each contribution must be | 
					
						
							|  |  |  | carefully scrutinized from a technical and legal perspective. | 
					
						
							| 
									
										
										
										
											2014-02-07 10:53:40 +00:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-10-21 13:43:40 +00:00
										 |  |  | Many commercial products and open source projects have been very lax regarding | 
					
						
							|  |  |  | licensing. They are ticking timebombs that no commercial product should use. | 
					
						
							| 
									
										
										
										
											2014-02-07 10:53:40 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-10-21 13:43:40 +00:00
										 |  |  | ## Required Reading
 | 
					
						
							| 
									
										
										
										
											2014-02-07 10:53:40 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | These are pretty short reads and emphasize the importance of proper licensing: | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-10-21 13:43:40 +00:00
										 |  |  | - https://web.archive.org/web/20200916173942/https://github.com/jazzband/tablib/issues/114 | 
					
						
							| 
									
										
										
										
											2014-02-07 10:53:40 +00:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-10-21 13:43:40 +00:00
										 |  |  | - https://web.archive.org/web/20240909210554/https://github.com/stephen-hardy/xlsx.js/issues/8 | 
					
						
							| 
									
										
										
										
											2014-02-07 10:53:40 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-10-21 13:43:40 +00:00
										 |  |  | ## Raising Issues
 | 
					
						
							| 
									
										
										
										
											2015-04-02 20:32:22 +00:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-10-21 13:43:40 +00:00
										 |  |  | Issues should generally be accompanied by test files. It is strongly recommended | 
					
						
							|  |  |  | to use the [issue tracker](https://git.sheetjs.com/sheetjs/sheetjs/issues). | 
					
						
							| 
									
										
										
										
											2015-04-02 20:32:22 +00:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-10-21 13:43:40 +00:00
										 |  |  | If they cannot be shared publicly, please send files to <oss@sheetjs.com> | 
					
						
							|  |  |  | (subject line should contain issue number or message) or share links to files | 
					
						
							|  |  |  | hosted on a storage service. Unless expressly permitted, attachments will not be | 
					
						
							|  |  |  | shared outside of SheetJS LLC or included in a test suite. | 
					
						
							| 
									
										
										
										
											2015-04-02 20:32:22 +00:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-10-21 13:43:40 +00:00
										 |  |  | If a NDA is required, please send an email to <oss@sheetjs.com> with subject | 
					
						
							|  |  |  | line "Non-Disclosure Agreemeant Request". | 
					
						
							| 
									
										
										
										
											2020-06-12 21:37:07 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-10-21 13:43:40 +00:00
										 |  |  | ## Opening Pull Requests
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Please raise an issue before opening pull requests. It is easy to solve a | 
					
						
							|  |  |  | specific problem without considering the full context or implications. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ## Pre-Contribution Checklist
 | 
					
						
							| 
									
										
										
										
											2014-02-07 10:53:40 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | 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 | 
					
						
							| 
									
										
										
										
											2024-10-21 13:43:40 +00:00
										 |  |  |   Corporation or a subsidiary. | 
					
						
							| 
									
										
										
										
											2014-02-07 10:53:40 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | - 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 | 
					
						
							| 
									
										
										
										
											2024-10-21 13:43:40 +00:00
										 |  |  | issue. If it is a particularly high-priority issue, please drop an email to | 
					
						
							|  |  |  | <support@sheetjs.com> and it will be prioritized. | 
					
						
							| 
									
										
										
										
											2014-02-07 10:53:40 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-10-21 13:43:40 +00:00
										 |  |  | ## Intra-Contribution
 | 
					
						
							| 
									
										
										
										
											2014-02-07 10:53:40 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | Keep these in mind as you work: | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-10-21 13:43:40 +00:00
										 |  |  | - Your contributions are your original work. Take note of any resources you | 
					
						
							| 
									
										
										
										
											2024-04-27 23:49:12 +00:00
										 |  |  |   consult in the process. Be extra careful not to use unlicensed code on the | 
					
						
							|  |  |  |   Internet or code generated by a large language model or other AI tool. | 
					
						
							| 
									
										
										
										
											2014-02-07 10:53:40 +00:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-10-21 13:43:40 +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 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2024-10-21 13:43:40 +00:00
										 |  |  | ## Post-Contribution
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Before certain contributions are merged, you will receive an email (at the | 
					
						
							|  |  |  | address associated with the git commit) and will be asked to confirm the | 
					
						
							|  |  |  | aforementioned items. Ensure that the email addresses associated with the | 
					
						
							|  |  |  | commits are valid. |