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.

Sign up for GitHub

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

Jump to bottom

Clarify contribution for main-distribution packages #3991

Merged
merged 1 commit into from
Sep 17, 2021
Merged

Clarify contribution for main-distribution packages #3991

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
26 changes: 21 additions & 5 deletions build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -747,15 +747,31 @@ Guidelines](#33-general-contribution-guidelines).
### 3.2. Distribution-Package Contributions

If you find yourself changing a file that is in a `"share/pkgs"`
subdirectory, then that file is not part of the main Racket Git
repository. It almost certainly has its own Git repository somewhere
else, possibly within
subdirectory (either installed as part of a Racket release or as a
product of an in-place build), then that file is not part of the main
Racket Git repository. It almost certainly has its own Git repository
somewhere else, possibly within
[https://github.com/racket](https://github.com/racket), but possibly in
another user’s space. The name of the directory in `"share/pkgs"` is
almost certainly the package name.

To start working on a package <_pkg-name_>, it’s usually best to go to
the root directory of your Racket repository checkout and run
To start working on a package <_pkg-name_> from a Racket release or
snapshot, you first need to adjust the package installation to use the
source specified by the main package catalog

  `raco pkg update --no-setup --catalog https://pkgs.racket-lang.org
<pkg-name>`

and then in the directory you’d like to hold the package’s source

  `raco pkg update --clone <pkg-name>`

will clone the package’s source Git repository into `"<pkg-name>"`
within the current directory.

Alternatively, if you already have an in-place build of the main Racket
repository, you can start working on a package <_pkg-name_>, by going to
the root directory of your Racket repository checkout and running

  `raco pkg update --clone extra-pkgs/<pkg-name>`

Expand Down
26 changes: 21 additions & 5 deletions pkgs/racket-build-guide/contribute.scrbl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,15 +76,31 @@ See the @secref["contribute-guidelines"].
@section[#:tag "pkg-contribute"]{Distribution-Package Contributions}

If you find yourself changing a file that is in a
@filepath{share/pkgs} subdirectory, then that file is not part of the
main Racket Git repository. It almost certainly has its own Git
repository somewhere else, possibly within
@filepath{share/pkgs} subdirectory (either installed as part of a
Racket release or as a product of an in-place build), then that file
is not part of the main Racket Git repository. It almost certainly has
its own Git repository somewhere else, possibly within
@url{https://github.com/racket}, but possibly in another user's space.
The name of the directory in @filepath{share/pkgs} is almost certainly
the package name.

To start working on a package @nonterm{pkg-name}, it's usually best to
go to the root directory of your Racket repository checkout and run
To start working on a package @nonterm{pkg-name} from a Racket release
or snapshot, you first need to adjust the package installation to use
the source specified by the main package catalog

@commandline{raco pkg update @DFlag{no-setup} @DFlag{catalog} https://pkgs.racket-lang.org @nonterm{pkg-name}}

and then in the directory you'd like to hold the package's source

@commandline{raco pkg update @DFlag{clone} @nonterm{pkg-name}}

will clone the package's source Git repository into
@filepath{@nonterm{pkg-name}} within the current directory.

Alternatively, if you already have an in-place build of the main
Racket repository, you can start working on a package
@nonterm{pkg-name}, by going to the root directory of your Racket
repository checkout and running

@commandline{raco pkg update @DFlag{clone} extra-pkgs/@nonterm{pkg-name}}

Expand Down