2.7 KiB
Contributing to Wave Terminal
We welcome and value contributions to Wave Terminal! Wave is an open source project, always open for contributors. There are several ways you can contribute:
- Submit issues related to bugs or new feature requests
- Fix outstanding issues with the existing code
- Contribute to documentation
- Spread the word on social media (tag us on LinkedIn, Twitter/X)
- Or simply ⭐️ the repository to show your appreciation
However you choose to contribute, please be mindful and respect our code of conduct.
All contributions are highly appreciated! 🥰
Before You Start
We accept patches in the form of github pull requests. If you are new to github, please review this github pull request guide.
Contributor License Agreement
Contributions to this project must be accompanied by a Contributor License Agreement (CLA). You (or your employer) retain the copyright to your contribution, this simply gives us permission to use and redistribute your contributions as part of the project.
On submission of your first pull request you will be prompted to sign the CLA confirming your original code contribution and that you own the intellectual property.
Style guide
The project uses American English.
Coding style and formatting is automated for each pull request. We use Prettier.
How to contribute
- For minor changes, you are welcome to open a pull request.
- For major changes, please create an issue first.
- If you are looking for a place to start take a look at open issues.
- Join the Discord channel to collaborate with the community on your contribution.
Development Environment
To build and run wave term locally see instructions below:
Create a Pull Request
Guidelines:
- Before writing any code, please look through existing PRs or issues to make sure nobody is already working on the same thing.
- Develop features on a branch - do not work on the main branch
- For anything but minor fixes, please submit tests and documentation
- Please reference the issue in the pull request