Good first issues

[phseiff]

There are some details in the implementation that are less-than-ideal, not connected to any of the other bigger issues I already created for this repository, and relatively separated from specification content and bigger concepts.
These issues are mostly marked as "ToDo" in the implementation (note that not every issue marked as ToDo is necessarily one of them). If you want, you can work on one of them and create a pull request (especially those regarding the warning system), but please raise an issue before you do to discuss the way you go about the implementation, so we can make sure it doesn't get into the way of vague design decisions that need to be upheld for later features.

[Kushagrabainsla]

I want to contribute, what exactly I've to do?

[phseiff]

I think the best way to get started is contributing to the way in which warnings are raised.

gender*render uses a system (gender_render.warnings) to show warnings and allow fine-grained customization of which warnings are shown and which are not.
This allows custumization of ones warning settings via gender_render.warnings.WarningManager.set_warning_settings(), and warnings are raised by calls to gender_render.warnings.WarningMessager.raise_warning().

This does, however, come with the downside that warnings are always shows with the file name "gender_render.warnings" and the line number in which gender_render.warnings.WarningMessager.raise_warning calls warnings.warn(), rather than the file name and line number from which gender_render.warnings.WarningMessager.raise_warning itself is called. Changing this behavior would require looking for the file name and line number in the stack (as discussed in this stack overflow question), and changing the file name and line number in the output of warnings.warn() (possibly requires monkeypatching python's buildin warnings-module).

This is also documented in the 2nd ToDo-comment in gender_render.warnings.WarningMessager.raise_warning; the first one corresponds to a separate addition (which you could implement in a separate pull request if you'd like to; ask me for additional information on this if you want to).

If you make a pull request for this, you'd also need to agree that the contents of said pull request are licensed together with the rest of the gender*render implementation under the MIT license; I plan to add a CLA assistent for that to the repository, so that's merely a formality.

Contributions to gender_render source code should follow PEP8 convention.

Please feel free to ask additional questions or ask for clarification on my explanation, and thank you for your interest in contributing!

[Gauravkain]

I want to contribute, can u just tell me what to do exactly?

[phseiff]

Hello, and thank you for your interest in contributing!

@Gauravkain it somewhat depends on whether Kushagrabainsla is still interested in contributing.... If they are not, I would suggest you to tackle the issue I had for Kushagrabainsla, and if they are still interested in contributing, I will find something else for you to work on and give you detailed instructions on what you can do. I hope you don't mind if we wait for them to answer...

@Kushagrabainsla are you still interested in contributing? If not, I would assign the issue I had for you to Gauravkain. But no need to rush yourself; if you don't have time to work on it for now, but still intend to work on it in the future, I will find something else for them to work on.

[phseiff]

I've removed the good first issues-label for now until I recived an answer, to avoid attracting more potential contributers than this repository can handle at its current stage.

@Kushagrabainsla I'd greatly appreciate it if you could give me a short reply on whether you still want to contribute, so that I know whether I can expect a pull request sometime or whether I can assign the issue to Gauravkain/ tackle it myself.

[Kushagrabainsla]

@phseiff, Right now I'm working on something else, so you should assign this issue to @Gauravkain.
and I'm definitely going to work on any other issue in the near future.

[phseiff]

@Gauravkain You can create a pull request for this issue, if you want to. I can also open a separate GitHub issue specifically for this, which I can then explicitely assign to you if you comment on it, in case you'd like that.

After you've created your pull request, I'll review the changes you made and potentially ask for some adjustments to be made (but I can also do them myself in case you run our of time) and then merge it.
Most information and instructions related to the feature should be found in the explanation message I linked above, but feel free to ask for clarification or any other additional questions.

[nithya6875]

Hey @phseiff. I want to contribute to this issue. I will be working continuously on it once it is assigned to me.