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

Replace the contributing guide #306

Merged
merged 1 commit into from
Oct 27, 2024

Conversation

MGaetan89
Copy link
Member

@MGaetan89 MGaetan89 commented Sep 12, 2024

This PR replaces the contributing guide to include the one from robolectric/robolectric.

That guide is more useful on robolectric/robolectric, since it is accessible when opening a PR.
However, it is also useful here, since there is a Contributing section.
This PR allows sharing the same document on both sides.

The downside is that a new build on this repo is required when updating the document on robolectric/robolectric in order for the dedicated page to be updated.

You can find the documentation for the syntax used here: https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#embedding-external-files

This PR replaces the [contributing guide](https://robolectric.org/contributing/) to include the one from [robolectric/robolectric](https://github.com/robolectric/robolectric/blob/master/.github/CONTRIBUTING.md).
@MGaetan89 MGaetan89 force-pushed the include_contributing_guide branch from 441ae67 to 2df6a81 Compare October 24, 2024 06:29
@MGaetan89 MGaetan89 marked this pull request as ready for review October 24, 2024 06:30
@MGaetan89
Copy link
Member Author

This can now be reviewed, as robolectric/robolectric#9574 has been merged.

@utzcoz
Copy link
Member

utzcoz commented Oct 24, 2024

It's fine for me. But it's strange that Robolectric repository refers some links to robolectric.github.io, and robolectric.github.io refers some links to Robolectric repository.

@MGaetan89
Copy link
Member Author

The perks of having two repositories 😅
I try to put as much documentation as possible in this repo, but some things are more meaningful in robolectric/robolectric in my opinion.

@MGaetan89 MGaetan89 merged commit db02a35 into robolectric:master Oct 27, 2024
1 check passed
@MGaetan89 MGaetan89 deleted the include_contributing_guide branch October 27, 2024 07:59
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.

2 participants