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

Update README instructions for version .71.x setup #169

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

ajaman190
Copy link
Contributor

Updated README.md file #163

Summary:
This pull request involves updates in the setup instructions for the new version of Go-social app.

Issues:

  1. Outdated instructions for setting up Firebase, React Native CLI, Google Map API, and Facebook authentication.
  2. Missing iOS configuration instructions.
  3. No contribution guidelines provided.

Checklists:

  • Updated setup instructions to the latest version.
  • Included iOS configuration instructions.
  • Added contribution guidelines.

@ajaman190 ajaman190 requested a review from shehand as a code owner March 11, 2023 13:38
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@shehand shehand left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Few more things that I missed previously.

Comment on lines -3 to -4
When contributing to this repository, please first discuss the change you wish to make via issue,
email, or any other method with the owners of this repository before making a change.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should keep this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have actually split this line into two steps for better understanding and easy to follow contribution guideline.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

adding a sample contributing guideline for references -> https://github.com/github/docs/blob/main/CONTRIBUTING.md

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have gone through this sample guideline document, and it seems that the points mentioned there are already covered in the three points I proposed below. These points will be easy to follow for any new contributors.

What do you recommend? Should I elaborate the contribution guideline or keep it concise & easy to follow steps?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this one need to resolve?

@@ -1,7 +1,15 @@
# Contributing

When contributing to this repository, please first discuss the change you wish to make via issue,
email, or any other method with the owners of this repository before making a change.
Thank you for your interest in contributing to our project! We welcome all contributions, whether it's a bug fix, feature suggestion, or documentation improvement.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think keeping this, will be appreciate the aspiring contributors as it will help them feel more welcome to this project.

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
Comment on lines 11 to 12
5. Make your changes and commit them with descriptive commit messages
6. Open a `Pull request` from your forked repository to the original repository. [Pull_Request_Template](https://github.com/scorelab/Go-social/blob/14e5dfcdfb59888efc318bb4835e3577d5d09532/.github/PULL_REQUEST_TEMPLATE.md)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Combine this. Something like ->

  • Commit the changes and open a PR from you fork copy.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this fine?

  • Commit your changes with clear messages and open a Pull Request from your forked repository to the original one for contribution. Pull_Request_Template

@shehand shehand requested a review from Wathsara March 12, 2023 04:32
@ajaman190 ajaman190 requested review from shehand and removed request for Wathsara March 12, 2023 05:54
@shehand
Copy link
Collaborator

shehand commented Mar 12, 2023

@Wathsara please take a look into this. Thanks!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@ajaman190
Copy link
Contributor Author

Hello @shehand, is there any further changes?

@shehand
Copy link
Collaborator

shehand commented Mar 16, 2023

@ajaman190, yes you have not addressed the last comments. Please address them. And you should resolve a conversation once the conversation is actually resolved.

@ajaman190
Copy link
Contributor Author

ajaman190 commented Mar 17, 2023

@ajaman190, yes you have not addressed the last comments. Please address them. And you should resolve a conversation once the conversation is actually resolved.

Which issue is need to be resolve please brief it? I would be glad to address it at the earliest.

@ajaman190
Copy link
Contributor Author

@shehand Added the Facebook configuration instructions in the readme.md, please review it.

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

Successfully merging this pull request may close these issues.

2 participants