Thank you for your interest in contributing to Flexpilot! We welcome contributions from the community and are grateful for any time you're willing to contribute.
Flexpilot is currently licensed under the GNU General Public License v3.0 (GPLv3). While contributing under this license, please ensure you understand its terms. However, please note that by signing our CLA, you grant us the flexibility to potentially change the license in the future.
-
Found a bug?
- Check our issue tracker to see if it's already reported
- If not, create a new issue with detailed information about how to reproduce it
-
Want to contribute?
- Visit our project board to find tasks and features we need help with
- Feel free to pick up any open issues or suggest new features
By contributing to Flexpilot, you agree to the following terms of our Contributor License Agreement:
For good and valuable consideration, receipt of which I acknowledge, I agree to the following terms and conditions:
-
Definitions:
- "Code" means the computer software code, whether in human-readable or machine-executable form, that I submit to Flexpilot.
- "Submit" means any form of electronic, verbal, or written communication sent to Flexpilot, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems.
- "Contribution" means any Code, documentation, or other original work of authorship that is Submitted by me to Flexpilot.
-
Grant of Rights:
- I grant to Flexpilot and to recipients of software distributed by Flexpilot a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license to use, copy, modify, and distribute my Contributions.
- I understand and agree that my Contributions may be included in commercial products by Flexpilot.
- I grant Flexpilot the right to change the license of my Contributions without additional permission, even though the project currently uses the GNU GPLv3 license.
-
Originality of Work:
- I represent that each of my Contributions is entirely my original work.
- Where I wish to Submit materials that are not my original work, I will clearly identify the source and any license or other restriction of which I am personally aware.
-
Moral Rights:
- To the fullest extent permitted under applicable law, I waive all moral rights in my Contributions in favor of Flexpilot.
-
Third Party Rights:
- I represent that I am legally entitled to grant the above license.
- If my employer(s) has rights to intellectual property that I create that includes my Contributions, I represent that I have received permission to make Contributions on behalf of that employer.
-
Future Changes:
- I acknowledge that Flexpilot is not obligated to use my Contributions and may decide to include any Contribution Flexpilot considers appropriate.
- I understand that while the project is currently under GNU GPLv3, my contributions may be used in a commercial product and that Flexpilot reserves the right to change the license or move to a proprietary license in the future.
- Fork the repository, clone the fork locally, and create a new branch.
- Run the
npm install
command to install the dependencies. - Open the project in VS Code and run the extension in Debug mode.
- Make your changes and check for errors by running
npm run lint
. - Format your code by running
npm run format
. - Push your changes and create a Pull Request against our main repository.
By participating in this project, you agree to abide by our Code of Conduct (see Code of Conduct.md).
Don't hesitate to write to us at contact@flexpilot.ai if you have any questions or need help with anything.
While Flexpilot is currently licensed under GNU GPLv3, by contributing to this project, you acknowledge and agree that your contributions will be licensed under the terms of our CLA, which permits Flexpilot to potentially relicense the code in the future.
Thank you for contributing to Flexpilot! 🚀