Skip to content

There is no proper docs for who want to contribute first time? #172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
shiviraj opened this issue Mar 4, 2021 · 2 comments
Closed

There is no proper docs for who want to contribute first time? #172

shiviraj opened this issue Mar 4, 2021 · 2 comments
Assignees
Labels
conclusion: resolved Issue was resolved topic: documentation Related to documentation for the project type: enhancement Proposed improvement

Comments

@shiviraj
Copy link

shiviraj commented Mar 4, 2021

I want to contribute in this project. But I am not getting any proper docs how to start contributing in this project. I cloned this repo in my machine. And I am not able to proceed further. Kindly prepare some docs where following details should be mentioned like:

  • dev machine setup guides
  • what dependencies are being used
  • how to run program
  • how to write unit test
  • how to write integration testing
@shiviraj shiviraj added the type: enhancement Proposed improvement label Mar 4, 2021
@rsora rsora added the topic: documentation Related to documentation for the project label Mar 4, 2021
@rsora
Copy link
Contributor

rsora commented Mar 4, 2021

Hi @shiviraj, we are happy that you want to contribute!
Please check here, we have a dev environment setup guide in the BUILDING.md file that should help you start to work on the codebase.

We will expand the documents mentioned above, adding information about testing in the following weeks.

Please note that currently for security reasons, our CI will probably fail once you push your code because it's not possible to sign Arduino IDE binaries if the CI runs on a fork. We are working to fix this anyway, I'll post a comment here once we have an update on the matter.

Happy coding!

@per1234
Copy link
Contributor

per1234 commented Oct 29, 2021

our CI will probably fail once you push your code because it's not possible to sign Arduino IDE binaries if the CI runs on a fork. We are working to fix this anyway, I'll post a comment here once we have an update on the matter.

Fixed by #213

@per1234 per1234 self-assigned this Nov 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
conclusion: resolved Issue was resolved topic: documentation Related to documentation for the project type: enhancement Proposed improvement
Projects
None yet
Development

No branches or pull requests

3 participants