Upstream/waveterm
1
0
Fork 0
mirror of https://github.com/wavetermdev/waveterm.git synced 2024-12-21 16:38:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

update outdated contributing links (#815)

Browse Source
This commit is contained in:
Mike Sawka 2024-09-24 15:48:02 -07:00 committed by GitHub
parent 72068f6fbc
commit 001076fd80
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 24 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
CONTRIBUTING.md
View File

@ -1,47 +1,51 @@
# 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](https://github.com/wavetermdev/waveterm/issues) with the existing code
* Contribute to [documentation](https://github.com/wavetermdev/waveterm-docs)
* Spread the word on social media (tag us on [LinkedIn](https://www.linkedin.com/company/commandlinedev), [Twitter/X](https://twitter.com/commandlinedev))
* Or simply ⭐️ the repository to show your appreciation
- Submit issues related to bugs or new feature requests
- Fix outstanding [issues](https://github.com/wavetermdev/waveterm/issues) with the existing code
- Contribute to [documentation](https://github.com/wavetermdev/waveterm-docs)
- Spread the word on social media (tag us on [LinkedIn](https://www.linkedin.com/company/wavetermdev), [Twitter/X](https://x.com/wavetermdev))
- Or simply ⭐️ the repository to show your appreciation
However you choose to contribute, please be mindful and respect our [code of conduct](./CODE_OF_CONDUCT.md).
> 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](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).
### 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](https://prettier.io/).
## How to contribute
* For minor changes, you are welcome to [open a pull request](https://github.com/wavetermdev/waveterm/pulls).
* For major changes, please [create an issue](https://github.com/wavetermdev/waveterm/issues/new) first.
* If you are looking for a place to start take a look at [open issues](https://github.com/wavetermdev/waveterm/issues).
* Join the [Discord channel](https://discord.gg/XfvZ334gwU) to collaborate with the community on your contribution.
- For minor changes, you are welcome to [open a pull request](https://github.com/wavetermdev/waveterm/pulls).
- For major changes, please [create an issue](https://github.com/wavetermdev/waveterm/issues/new) first.
- If you are looking for a place to start take a look at [open issues](https://github.com/wavetermdev/waveterm/issues).
- Join the [Discord channel](https://discord.gg/XfvZ334gwU) to collaborate with the community on your contribution.
### Development Environment
To build and run wave term locally see instructions below:
* [MacOS build instructions](./BUILD.md)
* [Linux build instructions](./build-linux.md)
- [README](./README.md)
### 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
- 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