Skip to content
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

[hacktoberfest] instructions for contributors - list of backlog items - read this first #1286

Closed
ptrthomas opened this issue Sep 18, 2020 · 28 comments

Comments

@ptrthomas
Copy link
Member

Thank you for your interest in contributing to Karate ! We have a set of well-documented roadmap items and enhancements proposed here: https://github.com/intuit/karate/projects/3

image

All you need to do is choose what you wish to work on, look at the Proposed column - and then we will move the status of that item to Assigned. You can discuss here in this issue, just add a comment.

IMPORTANT: after your first comment here, we will assign the item to you, but we need you to demonstrate intent to work on the item within 5 days. Just create a new issue with a brief comment saying that you are working on it. This will be the issue against which you can submit the final PR (Pull Request). It would be great if you can also provide some details of how you are planning to implement the solution. If we don't hear from you within 5 days, we will move the item back to the pile for anyone else to pick up.

Once your code is ready, just submit a Pull Request (in October 2020) and reference this issue. That's it ! May the Source be with You :) (Or should I say October ;)

To summarize:

A) choose an item you want to work on from the roadmap
B) make a comment below mentioning which item, and we will assign it to you
C) within 5 days create an issue so that we know you are actively working on it (else the item moves back to being un-assigned)
D) when your code is ready (or draft) submit a PR and refer the issue you created in (C)

Contributing to Karate is easy, especially for Java programmers. We have a detailed developer guide here: https://github.com/intuit/karate/wiki/Developer-Guide

@ptrthomas ptrthomas changed the title [hacktoberfest] [hacktoberfest] 2020 instructions for contributors and list of backlog items - please read Sep 18, 2020
@ptrthomas ptrthomas changed the title [hacktoberfest] 2020 instructions for contributors and list of backlog items - please read [hacktoberfest] instructions for contributors - list of backlog items - read this first Sep 18, 2020
@shreyamalik19
Copy link

Hi, could you please assign https://github.com/intuit/karate/projects/3#card-41317200 to me? Thanks!

@ptrthomas
Copy link
Member Author

@shreyamalik19 done

@ptrthomas
Copy link
Member Author

@Nishant-sehgal done #1181 (comment)

shreyamalik19 pushed a commit to shreyamalik19/karate that referenced this issue Oct 4, 2020
@chaudharydeepak
Copy link
Contributor

Hi, can you pls assign https://github.com/intuit/karate/projects/3#card-41317122 to me?Thank you.

@ptrthomas
Copy link
Member Author

@chaudharydeepak yes go ahead

@Nishant-sehgal
Copy link
Contributor

@ptrthomas Can you assign #1076 to me?

@ptrthomas
Copy link
Member Author

@Nishant-sehgal done

@sixdouglas
Copy link

Hi @ptrthomas can you assigne me this ticket :
https://github.com/intuit/karate/projects/3#card-36146380

@ptrthomas
Copy link
Member Author

@sixdouglas done

@sixdouglas
Copy link

Hi,
Can you tell me more about what you have in mind in this card:
https://github.com/intuit/karate/projects/3#card-32867382
I would be happy to help you any further but I'm not sure to understand it well.

@ptrthomas
Copy link
Member Author

@sixdouglas that is hard to explain in short and may require you to read the links provided. but the goal is test-case generation. where the user needs to only specify some rules e.g. data-types (where karate has an existing system, e.g. #string #boolean etc) and then some optional additional rules: e.g. "name should be less than 20 chars". and then you get something like this as a result: https://github.com/Endava/cats

@Nishant-sehgal
Copy link
Contributor

@ptrthomas can you assign #1175 to me?

@ptrthomas
Copy link
Member Author

@Nishant-sehgal done

@sixdouglas
Copy link

@ptrthomas so let’s put it simple. What you wish to have, is a system that can generate multiple values as query inputs to call the tested system (and so multiple test executions), according to some rules.

In the case of the Endava CATS, the rules are defined in the OpenAPI contract.

If the user defines a schema like this :

{ id: "#number", name: "#string" }

and calls that new 'module' saying he wants 200 possibilities. The module will make 200 calls to the API with a payload corresponding to this schema, but with values generated automatically.

Is that correct?

@ptrthomas
Copy link
Member Author

@sixdouglas yes that's right

@sixdouglas
Copy link

@ptrthomas : you can assign the ticket to me. I'll create the issue to discuss it further with you.

@ptrthomas
Copy link
Member Author

@sixdouglas done

@sixdouglas
Copy link

sixdouglas commented Oct 9, 2020

@ptrthomas : I would love to try the Github Actions too
https://github.com/intuit/karate/projects/3#card-26888700

@ptrthomas
Copy link
Member Author

@sixdouglas github actions also assigned

@tup916
Copy link

tup916 commented Oct 13, 2020

Hi, I was wondering if I could do some refactoring around this file? As a karate user, I often find myself reading through this and wishing more/better features could spring up from here if it the design allowed a bit of extension. I am not sure how to go about doing this. I would ideally just fork and create a PR, but it seems like you want contributions done a certain way? Just wanted to make sure first.

@ptrthomas
Copy link
Member Author

@tup916 I'm right now doing a major overhaul of the code, see #1281 and the rewrite branch. I'm leaving the Runner for the end but any ideas and suggestions will help, this is the time, even if this may not align to a hacktoberfest timeline. please comment on 1281 with your ideas to start with even if it is a wishlist, so we can start planning for that

@Nishant-sehgal
Copy link
Contributor

@ptrthomas can you assign #1243 to me?

@ptrthomas
Copy link
Member Author

ptrthomas commented Oct 15, 2020

@Nishant-sehgal yes go ahead. if you comment on that ticket I will assign

@wpanas
Copy link

wpanas commented Oct 18, 2020

@ptrthomas
Copy link
Member Author

@wpanas done

@chaudharydeepak
Copy link
Contributor

@ptrthomas - Hi Peter, I am interested in working on - https://github.com/intuit/karate/projects/3#card-30212558. I have some ideas around it and can share on the ticket / issue log itself. Thank you.

@ptrthomas
Copy link
Member Author

@chaudharydeepak that's a good one. take your time - even if you don't make the hacktoberfest deadline

@chaudharydeepak
Copy link
Contributor

@chaudharydeepak that's a good one. take your time - even if you don't make the hacktoberfest deadline

@ptrthomas - starting to look into it - realizing that possibly I can cover other items like performance metrics etc, as its all kind of encompassing with devtools protocol[chrome] - and really enjoyed the way current drivers are written / designed. Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

7 participants