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

Docs for Contribution Criteria and User Interface Style #135

Open
HarshCasper opened this issue Jul 5, 2021 · 8 comments
Open

Docs for Contribution Criteria and User Interface Style #135

HarshCasper opened this issue Jul 5, 2021 · 8 comments
Assignees
Labels
Documentation Issue / feature refers to docs not code Help Wanted Need some help with this task. Need clarification Propose a way to better communicate a feature P1 Medium priority issue

Comments

@HarshCasper
Copy link
Member

Description

The two documents Contribution Criteria & User Interface Style Guide marked as To be completed were deleted off in this commit 0c42be0. We need to finish them and bring them back to the Governance docs.

The Contribution Criteria docs overlap with the CONTRIBUTING.md we already have on the repository, so I would like to have inputs from @aornugent and @shubhamkarande13 on whether we actually need them.

For the User Interface Style Guide, do we have something firm in place to actually document? @aornugent I would like to have some of your inputs on the same.

@HarshCasper HarshCasper added Documentation Issue / feature refers to docs not code Help Wanted Need some help with this task. Need clarification Propose a way to better communicate a feature P1 Medium priority issue labels Jul 5, 2021
@shubhamkarande13
Copy link
Member

If the content from Contribution Criteria docs are already merged in Contributing.md then we don't need
Contribution Criteria docs in the repo.✌️

@unnati914
Copy link

unnati914 commented Oct 4, 2021

I would like to work on this issue

@HarshCasper
Copy link
Member Author

I would like to work on this issue

Hi @unnati914 👋

Thanks for taking it up! We had a lot of discussions about this part and we would like the CONTRIBUTING.md to be specific to this repository itself! All in all, we would like to cover these points:

  • Forking and cloning the project
  • Making changes for them on a branch
  • Committing the changes (including some best practices)
  • How to resolve merge conflicts
  • Directory Structure (what purpose each directory serves; just a high-level overview)

You can use your own intuition to add more details if you wish. These parts would help a lot of our users (scientists, policy makers, researchers) who are not very familiar with Git & GitHub to contribute. Thanks a lot for your contributions!

@unnati914
Copy link

Hi @HarshCasper :) Tysm for assigning this issue. Just to clear, I have to only add UI Style Doc to Governance Doc right?

@HarshCasper
Copy link
Member Author

Hi @HarshCasper :) Tysm for assigning this issue. Just to clear, I have to only add UI Style Doc to Governance Doc right?

There is not a firm idea of what we wish to do with the same. So for now, you can just skip that part.

@Angelvicks
Copy link

Hello @HarshCasper , I am an Outreachy Applicant, if this issue is still available, I will like to work on this?

@mehabhalodiya
Copy link

@HarshCasper Is this issue still open to work on?
Please let me know, as I am interested to work on Docs!

@meenaljain0303
Copy link
Contributor

I can work on this issue, please assign it to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issue / feature refers to docs not code Help Wanted Need some help with this task. Need clarification Propose a way to better communicate a feature P1 Medium priority issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants