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

Added a note in README on managing upstream URLs. #58

Merged
merged 3 commits into from
Aug 31, 2024

Conversation

santacodes
Copy link
Collaborator

Added a note pointing to the GitHub documentation with instructions on adding an upstream URL to the generated project.

Fixes #35

Copy link
Member

@agriyakhetarpal agriyakhetarpal left a comment

Choose a reason for hiding this comment

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

I don't wish to be too nitpicky, but this sentence implies that a remote repository that users can push to already exists on GitHub. Could you please reword this section so that it mentions a link to explain how one can create a GitHub repository and link it with the one that gets created in the directory?

Also, if users were to add a license (and/or a README) to a new repository that they create on GitHub's UI, and then create a Git repository locally to link to it, they could face troubles when they try to push the changes because the remote repository would not be empty. That's something to think about, too, since we can expect some users of the template to be new to both Git as a version control system and to how it interacts with GitHub.

There is also a pathway where they don't have a remote repository at all and they would want to try publishing the one they created locally to GitHub, which requires different steps. All of this information is available in depth in the GitHub documentation, so just linking it together in the right manner should be fine. 👍

README.md Outdated Show resolved Hide resolved
@santacodes
Copy link
Collaborator Author

@agriyakhetarpal the new link should cover all the points that you mentioned.

Copy link
Member

@agriyakhetarpal agriyakhetarpal left a comment

Choose a reason for hiding this comment

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

This looks better, thanks, @santacodes!

@santacodes santacodes merged commit 90429df into pybamm-team:main Aug 31, 2024
84 checks passed
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.

Issues when trying the template
2 participants