search

mikaelacaron / brain-marks

[Not Active] Open-source iOS app to save and categorize tweets
MIT License
80 stars 47 forks source link

Documentation #80

Open mikaelacaron opened 3 years ago

mikaelacaron commented 3 years ago

Describe the solution you'd like Document all code with access level internal or higher, except declarations made for protocol conformance or overriding subclasses. This allows developers to understand the intention and function of the public interface of types.

Additional context This is the conform the the best practices described here

jocelyn-boyd commented 3 years ago

Hi Mikaela! ~ Could I get assigned to this issue? I'd like to try. :]

mikaelacaron commented 3 years ago

You got it! Let me know if you have any questions :)

jocelyn-boyd commented 3 years ago

Will do! Sorry I got slammed with take-home assignments and interviews. I'm gonna work start working on the issue this weekend.

Am I adding the above text into the readme? What exactly do you need me to do to clarify.

mikaelacaron commented 3 years ago

@jocelyn-boyd No worries! I'm in no hurry, you only have to submit the PR before Oct 31 for it to count for Hacktoberfest. Look at the Coding Style Guidelines in the Contributing file. Documentation is about documenting the code in the project. Some examples are here.

You should document all code where the access level of that code in internal or higher. This means going into the project and documenting what each class, property, function etc, does and what its purpose is. In Xcode, when you're on the line above a function, class, property, etc. You can click Option + Command + / to automatically make the documentation comment come up, this is the same as using three slashes /// comment here.

How this documentation works can also be found here.

So you are documenting the code itself, not the README.md file.

jocelyn-boyd commented 3 years ago

Where can I find my Twitter API key? I made an account.

mikaelacaron commented 3 years ago

Apply for one on the Twitter developer site, technically you wouldn't need one for this issue, but if you want to run the project you do need one

mikaelacaron commented 3 years ago

Just look around the site, I forget exactly which page it's on

jocelyn-boyd commented 3 years ago

I know, I just wanted to run it and see how it works on my computer.

Byw, just comment only on the files in the brain-marks folder? I finally have a chance today to sit down and go through it.

mikaelacaron commented 3 years ago

Yes just the brain-marks folder

jocelyn-boyd commented 3 years ago

Got it! 👍🏾

SuzGupta commented 2 years ago

If we want to use DocC: https://www.raywenderlich.com/34919511-docc-tutorial-for-swift-getting-started

ghost commented 2 years ago

I would like to contribute by documenting the functions. Could you please assign it to me ?

helloITdepartment commented 2 years ago

I'd like to help out with this if you still need it

mikaelacaron commented 2 years ago

@ankurwasnik is assigned this issue right now, but if they don't get to it in the next 3 days, go ahead!

@ankurwasnik let me know if you're still working on this

@helloITdepartment you can always find a different issue to work on :)

mikaelacaron commented 2 years ago

@ankurwasnik how's it going working on this issue? Do you have any questions? Do you think you'll complete it by the end of Hacktoberfest?

ghost commented 2 years ago

I think I will complete this before due.

On Tue, Oct 25, 2022 at 7:09 PM Mikaela Caron @.***> wrote:

@ankurwasnik https://github.com/ankurwasnik how's it going working on this issue? Do you have any questions? Do you think you'll complete it by the end of Hacktoberfest?

— Reply to this email directly, view it on GitHub https://github.com/mikaelacaron/brain-marks/issues/80#issuecomment-1290579600, or unsubscribe https://github.com/notifications/unsubscribe-auth/AQIAWF33FMAEC3O4DMNQUTLWE7PJTANCNFSM5F4EK7RQ . You are receiving this because you were mentioned.Message ID: @.***>

ghost commented 2 years ago

do we have to create a new file for all documentation or just add multi-line comments above each function ?

mikaelacaron commented 2 years ago

@ankurwasnik you should create multi-line comments, as described here

dcode333 commented 1 year ago

@mikaelacaron can I get this issue I want to contribute please

mikaelacaron commented 1 year ago

@mikaelacaron can I get this issue I want to contribute please

@dcode333 This project isn't active anymore. I can't maintain it because of changes to the Twitter API

dcode333 commented 1 year ago

@mikaelacaron I just want to make my first contribution as I have an assignment about it can you help me make my first contribution?? Please even if it's in the documentation...

mikaelacaron commented 1 year ago

@dcode333 Does your assignment require that I merge it? If not, you're more than welcome to make a PR, but I won't be merging it

dcode333 commented 1 year ago

@mikaelacaron The main thing is to get it merged..You can't help me in this regard??

mikaelacaron commented 1 year ago

@dcode333 No not for this issue, there's too many changes, and I don't have time to look at it, and I don't know what your timeframe is.

You could try this repo IceCubesApp that is currently being developed. I won't have another open source project to be worked on, until Hacktoberfest this October