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

mono - updating contributing guidelines to address build #944

Merged
merged 1 commit into from
Dec 26, 2024
Merged

mono - updating contributing guidelines to address build #944

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ pnpm test:services:start
You can contribute changes to this repo by opening a pull request:

1) After forking this repository to your Git account, make the proposed changes on your forked branch.
2) Run tests and linting locally by running `pnpm i && pnpm test`.
2) Run tests and linting locally by running `pnpm i && pnpm build && pnpm test`.
3) Commit your changes and push them to your forked repository.
4) Navigate to the main `cacheable` repository and select the *Pull Requests* tab.
5) Click the *New pull request* button, then select the option "Compare across forks"
Expand Down
16 changes: 1 addition & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,21 +27,7 @@ The website documentation for https://cacheable.org is included in this reposito

## Open a Pull Request

You can contribute changes to this repo by opening a pull request:

1) After forking this repository to your Git account, make the proposed changes on your forked branch.
2) You will need `docker` installed and running on your machine. Once it is installed run `pnpm test:services:start` to start the services needed for testing.
3) Run tests and linting locally.
- Run `pnpm i && pnpm test`.
4) Commit your changes and push them to your forked repository.
5) Navigate to the main `cacheable` repository and select the *Pull Requests* tab.
6) Click the *New pull request* button, then select the option "Compare across forks"
7) Leave the base branch set to main. Set the compare branch to your forked branch, and open the pull request.
8) Once your pull request is created, ensure that all checks have passed and that your branch has no conflicts with the base branch. If there are any issues, resolve these changes in your local repository, and then commit and push them to git.
9) Similarly, respond to any reviewer comments or requests for changes by making edits to your local repository and pushing them to Git.
10) Once the pull request has been reviewed, those with write access to the branch will be able to merge your changes into the `cacheable` repository.

If you need more information on the steps to create a pull request, you can find a detailed walkthrough in the [GitHub documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)
Please follow the [CONTRIBUTING](CONTRIBUTING.md) guidelines provided and remember you will need to do setup on this project such as having redis running (via docker), building the project `pnpm build`, and testing `pnpm test` which will also perform linting.

## Post an Issue

Expand Down
Loading