search

hexops / vecty

Vecty lets you build responsive and dynamic web frontends in Go using WebAssembly, competing with modern web frameworks like React & VueJS.
BSD 3-Clause "New" or "Revised" License
2.8k stars 143 forks source link

[Question]: How to contribute? #280

Open mvpmvh opened 3 years ago

mvpmvh commented 3 years ago

How does someone get involved in contributing to this project?

xoviat commented 3 years ago

Do you have some extra time? Then one thing you can do is fix vecty-material. vecty-material is basically material components for vecty. With vecty-material, it's possible to use material components rather than html components (of course everything is html under the hood, but material components are higher-level).

vecty-material has worked before but stopped working with the move to wasm. I've tried to get it working again, but it was more complex than I had the time for.

xoviat commented 3 years ago

In fact, I'd be willing to put in the time to get that project working if I had someone to bounce ideas off of.

VinceJnz commented 3 years ago

I have time to get involved but I'm not a very experienced developer.

xoviat commented 3 years ago

@VinceJnz see https://github.com/vecty-material/material/issues/22 if you want to help. Feel free to ask questions, but no guarantees that it will be easy.

slimsag commented 3 years ago

In general, it is not a good idea to just set out with a goal of "how can I contribute to an open source project X". Code is complex, you should get a solid understanding of specifically what and where you think it is important to contribute first. If you're not sure, it's a signal that you probably need more familiarity with the code before you will be able to contribute effectively. That's not a bad thing - not everyone needs to contribute to an open source project (despite what companies and recruiters might lead you to believe.)

I would encourage anyone looking to contribute to first:

VinceJnz commented 3 years ago

Thanks, I've been using vecty in my own side project over the last year, but I still have a lot to understand so I don't know how useful I can be.

VinceJnz commented 3 years ago

Is the master repository in github or gitlab?

VinceJnz commented 3 years ago

What version of Go should I be using?

ghost commented 2 years ago

What version of Go should I be using?

According to the go.mod file, you should be using version 1.14

ghost commented 2 years ago

Is the master repository in github or gitlab?

It's here on github.

ghost commented 2 years ago

In general, it is not a good idea to just set out with a goal of "how can I contribute to an open source project X". Code is complex, you should get a solid understanding of specifically what and where you think it is important to contribute first. If you're not sure, it's a signal that you probably need more familiarity with the code before you will be able to contribute effectively. That's not a bad thing - not everyone needs to contribute to an open source project (despite what companies and recruiters might lead you to believe.)

I would encourage anyone looking to contribute to first:

  • Make applications with Vecty and start understanding its tradeoffs / limitations of it
  • Build an understanding of the code and look at open issues to find limitations that you can maybe improve or make suggestions on, ask questions about how things work
  • Improve documentation, write articles/tutorials/etc for others
  • Contribute to projects using Vecty, rather than Vecty itself - if you are eager to dive into coding first that gives you an opportunity to start learning the project and its tradeoffs/limitations.

I think this is where the need for an official website arises. I was digging into the code and getting my hands dirty on a side project 😪. So far, it's been fun and definitely worth the time. I must commend the efforts of past contributors and sponsors. To attract more contributors and take this project to a level where it can be used in place of react or vue, then a proper documentation would go a long way. I was also trying out vugu for my pet project and it is quite nice too, but i prefer the implementation of vecty 😋.

Where i found it hard to get started using vecty was the lack of documentation as opposed to https://www.vugu.org/doc 😣. I would be willing to take this upon myself to start the development of the website and documentation as long as i have the support of other contributors 🤝 🙏. I believe working on the documentation will help me and others interested to understand the core functionality and implementation of vecty at a more in-depth scale.

I am almost certain that this will help onboard new developers into the community and take this project to the next level 🦾.