2.6 KiB
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. We are of the opinion that those are ticking timebombs and that no commercial product should depend on them.
Required Reading
These are pretty short reads and emphasize the importance of proper licensing:
-
https://github.com/jazzband/tablib/issues/114 (discussion of other tools)
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.
Opening Pull Requests
Squash commits
before opening a pull request, If the pull request addresses documentation or
demos, add [ci skip] in the body or title of the commit message to skip tests.
Pre-Contribution Checklist
Before thinking about contributing, make sure that:
-
You are not, nor have ever been, an employee of Microsoft Corporation.
-
You have not signed any NDAs or Shared Source Agreements with Microsoft Corporation or a subsidiary
-
You have not consulted any existing relevant codebase (if you have, please take note of which codebases were consulted).
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. Be extra careful not to use unlicensed code on the Internet or code generated by a large language model or other AI tool.
-
You are working on your own time. Unless they explicitly grant permission, your employer may be the ultimate owner of your IP
Post-Contribution
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 items. Ensure that the email addresses associated with the commits are valid.