pcdshub / pcdshub/shared-dotfiles
Suggested installation procedure
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 3
- Forks
- 15
- Avg merge
- 7d 10h
- Merged PRs (30d)
- 1
Description
The README shows multiple ways you could use the dotfiles.
I think use_dotfiles.sh script is maybe the wrong way for many of our engineers.
It assumes you're either OK with just using the shared-dotfiles or forking shared-dotfiles and modifying it for your own purposes.
It may be better to just recommend running the following as a beginner method:
$ echo 'source $HOME/dotfiles/on_site/bash_all.sh' >> $HOME/.bashrc
It only then assumes that bash_profile has been set up to source bashrc, which is probably the case for new users.
It lets you just add onto it by adding lines before/after the bash_all script and is a bit more flexible.
No changes to shared-dotfiles or forking required.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the installation guidance in README and compare it with use_dotfiles.sh and the suggested bashrc command in this issue. Update the beginner recommendation to explain the sourcing approach and its bash_profile assumption, then verify the README accurately describes the available setup methods.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- bash
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100