docs: adjust README.md and CONTRIBUTING.md #279
Merged
Conversation
This file contains hidden or 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
oracle-contributor-agreement
bot
added
the
OCA Verified
tromai
reviewed
Jun 2, 2023
CONTRIBUTING.md
Outdated
| ### Merging PRs | ||
|
|
||
| - Before a PR is merged, all commits in the PR should be rebased into meaningful commits. | ||
| - Before a PR is merged, all commits in the PR should meaningful commits. |
Contributor
There was a problem hiding this comment.
Suggested change
| - Before a PR is merged, all commits in the PR should meaningful commits. | |
| - Before a PR is merged, all commits in the PR should have meaningful commits. |
We could use another word if it make more sense.
|
|
||
| * The `main` branch is only used for releases and the `staging` branch is used for development. We only merge to `main` when we want to create a new release for Macaron. | ||
|
|
||
| ## Setting up the development environment |
Contributor
There was a problem hiding this comment.
Could you rebase on staging and update the reference to this section in docs/README.md - https://github.com/oracle-samples/macaron/blob/e6656c486f956e843e250d8dec3ace0bf36a2ecb/docs/README.md?plain=1#L7
CONTRIBUTING.md
Outdated
| ``` | ||
|
|
||
| ### Obtaining the GitHub personal access token | ||
| Create your own Github access token (please refer to the instructions [here](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token)). When creating this token, make sure to assign **at least** `repo` permissions. |
Contributor
There was a problem hiding this comment.
I think we can update the instruction on permission of the Github token by using parts of the instructions we have for the Sphinx documentation
Ideally, the GitHub token must have read permissions for the repositories that you want to analyze:
- Every fine-grained personal-access token should have read permission to public GitHub repositories. However, if you are analyzing a private repository, please select it in the Repository Access section.
- For classic personal-access token, the repo.public_repo scope must be selected. Please select the whole repo scope if you are running the analysis against private repositories.
Signed-off-by: behnazh-w <behnaz.hassanshahi@oracle.com>
Signed-off-by: behnazh-w <behnaz.hassanshahi@oracle.com>
behnazh-w
force-pushed
the
275-add-reference-to-the-github-pages-in-readmemd
branch
from
e46dc4e to
6de60e8
Compare
tromai
approved these changes
Jun 3, 2023
art1f1c3R
pushed a commit
that referenced
this pull request
Nov 29, 2024
Signed-off-by: behnazh-w <behnaz.hassanshahi@oracle.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Closes #275 and #272