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 .build to .gitignore #4722

Merged
merged 2 commits into from
Sep 22, 2023
Merged

Conversation

Bronek
Copy link
Collaborator

@Bronek Bronek commented Sep 22, 2023

Suggested in-tree build directory should be automatically excluded from git workspace, so users aren't confused when following instructions

Type of Change

Non-functional change

Suggested in-tree build directory should be automatically excluded from git workspace, so users aren't confused when following instructions
.gitignore Show resolved Hide resolved
@Bronek
Copy link
Collaborator Author

Bronek commented Sep 22, 2023

An alternative improvement is to amend BUILD.md to instruct the user to add /.build/ to .git/info/exclude or to user-level .gitignore (the latter is very intrusive, though), but some users prefer to have every useful exclude in the project-level .gitignore. Also I think it's a good practice to have sensible default that's consistent with the build instructions.

@intelliot
Copy link
Collaborator

Personally, I prefer to have every useful exclude in the project-level .gitignore, so I think this PR looks good as-is

Copy link
Collaborator

@godexsoft godexsoft left a comment

Choose a reason for hiding this comment

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

🚀

@intelliot intelliot merged commit e4db0fb into XRPLF:develop Sep 22, 2023
15 checks passed
sophiax851 pushed a commit to sophiax851/rippled that referenced this pull request Jun 12, 2024
Currently, the `BUILD.md` instructions suggest using `.build` as the
build directory, so this change helps to reduce confusion.

An alternative would be to instruct developers to add `/.build/` to
`.git/info/exclude` or to user-level `.gitignore` (although the latter
is very intrusive). However, it is being added here because it is a good
practice to have a sensible default that's consistent with the build
instructions.
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.

4 participants