Add CONTRIBUTING.md #64
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nikiburggraf
approved these changes
Jan 30, 2025
Comment on lines
+23
to
+31
| ### Step 1: Clone the Repository | ||
|
|
||
| To start using the package, clone the repository and navigate into the project | ||
| directory: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/uw-ssec/biodiversity-horizons.git | ||
| cd biodiversity-horizons | ||
| ``` |
There was a problem hiding this comment.
I wonder if we should change this to forking instead of cloning?
There was a problem hiding this comment.
Can do that, the Pull Request section at end however has the first step to Fork, should we also specify in the beginning?
IshikaKhandelwal
added a commit
to IshikaKhandelwal/biodiversity-horizons
that referenced
this pull request
Feb 4, 2025
* Add CONTRIBUTING.md * Add CONTRIBUTING.md
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes updates to the
CONTRIBUTING.mdfile. The changes provide detailed instructions for setting up the project locally, running the R scripts, and using Docker for containerized execution. Additionally, guidelines for contributing to the project and submitting pull requests are outlined.