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

Add a reference for our custom lint rules #1641

Closed
literalEval opened this issue Mar 8, 2023 · 8 comments · Fixed by PalisadoesFoundation/talawa-docs#393
Closed

Add a reference for our custom lint rules #1641

literalEval opened this issue Mar 8, 2023 · 8 comments · Fixed by PalisadoesFoundation/talawa-docs#393
Assignees

Comments

@literalEval
Copy link
Member

Is your feature request related to a problem? Please describe.
We recently implemented custom lint rules but some contributors are facing difficulty in getting hold of what the rules expect.

Describe the solution you'd like
Add an example file in talawa_lint directory that will contain an exhaustive list of examples of our custom lint rules.

Describe alternatives you've considered

  1. Add examples in CONTRIBUTING.md. But that will unnecessarily clutter this file.
  2. Add examples in the official Talawa doc. I believe this can be done in conjunction with the original solution presented in this issue, so that the official doc serves as the official source of truth while the file in talawa_lint will come handy in referencing stuff quickly and locally.
@github-actions github-actions bot added hold unapproved Unapproved, needs to be triaged labels Mar 8, 2023
@literalEval
Copy link
Member Author

@palisadoes please confirm so that I can open respective PR. Also, this issue is based on my conversation with some contributors who reached out to me.

@palisadoes
Copy link
Contributor

Talawa Docs would be the place. Then we can add a link to the page in the PR template.

@palisadoes palisadoes removed the unapproved Unapproved, needs to be triaged label Mar 8, 2023
@literalEval
Copy link
Member Author

@palisadoes I am getting Page not found for talawa-docs. Where am I supposed to updated these things ?

@palisadoes
Copy link
Contributor

It should be https://docs.talawa.io/docs/

@palisadoes
Copy link
Contributor

The DOCUMENTATION.md file has information. You will need to create an issue/PR here https://github.com/PalisadoesFoundation/talawa-docs

@literalEval
Copy link
Member Author

literalEval commented Mar 9, 2023

Should I add a Documentation section under Developer Resources --> Talawa ?
Right now Developer Resources --> Talawa has a single page called Overview, which contains a single line description of Talawa. Should I add another page as a sibling of Overview named Doc Comments and write stuff there ?

@palisadoes
Copy link
Contributor

palisadoes commented Mar 9, 2023

Add a new page there

@literalEval
Copy link
Member Author

Okay.

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

Successfully merging a pull request may close this issue.

2 participants