mirror of
https://github.com/varbhat/exatorrent.git
synced 2021-09-19 22:57:02 +03:00
32 lines
2.6 KiB
Markdown
32 lines
2.6 KiB
Markdown
Thank you for your interest in `exatorrent` . We highly appreciate it . You are welcome to contribute to `exatorrent` . But, please read this document completely .
|
|
|
|
**Please ask first before starting work on any significant new features**
|
|
|
|
It's never a fun experience to have your pull request declined after investing a lot of time and effort into a new feature. To avoid this from happening, we request that contributors create [an issue](https://github.com/varbhat/exatorrent/issues) or use [discussions](https://github.com/varbhat/exatorrent/discussions) to first discuss any **significant** new features.
|
|
|
|
|
|
**Everyone is welcome to contribute**
|
|
|
|
You are welcome to contribute . We only care about quality contributions . Consider this as Great Opportunity to contribute towards Open Source Software that will benefit the community and which will stay Open Source forever.
|
|
|
|
If you know [Go](https://go.dev) Programming Language , you can contribute to `exatorrent` by solving issues , finding bugs(if they exist) , adding new features if it can benefit the community (Please ask before if you are adding new features; see above).
|
|
Note that `exatorrent` except Web Client has been completely written in `Go` .
|
|
|
|
Web Client of `exatorrent` has been written in [Svelte](https://svelte.dev/) + [TypeScript](https://www.typescriptlang.org/) . Note that TypeScript is Typed Javascript that prevents many mistakes that are possible when using Javascript .
|
|
[Tailwind](https://tailwindcss.com/) CSS framework has been used for the UI . If you know Svelte / TypeScript / Tailwindcss , you can contribute towards improving Web Client . If you find any bugs in Web Client , please Open issue.
|
|
If you have expertise in UI/UX , you can work towards making Web Client more awesome and improving UI/UX of Web Client . If you are designer , you can contribute towards creating good identity (logo , favicon and other visual identities) for exatorrent .
|
|
|
|
Although we prefer Pull Requests , you are welcome to request new Feature in [Issues](https://github.com/varbhat/exatorrent/issues) or [Discussions](https://github.com/varbhat/exatorrent/discussions) . Please include `Feature Request` in the title of post .
|
|
|
|
**Code must be Formatted**
|
|
|
|
All `go` code must be formatted using `gofmt` . All Web code must be formatted using `Prettier` (with config existing in `web` subfolder).
|
|
|
|
**Improve Documentation**
|
|
|
|
You are free to improve Documentation of `exatorrent` .
|
|
|
|
**Spread the Word about exatorrent**
|
|
|
|
If you like `exatorrent` , popularize `exatorrent` by spreading and talking good things about it.
|