diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index baf13845ad..9ee325e585 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -94,11 +94,18 @@ The SRI project follows an open contributor model, where anyone is welcome to co `cargo fmt`: this command formats your code according to the project's style guidelines. Make sure to run this command to ensure consistency in code formatting. -5. **Submit a Pull Request:** once you're satisfied with your changes, submit a pull request to the original SRI repository. Provide a clear and concise description of the changes you've made. If your pull request addresses an existing issue, reference the issue number in the description. In order to contribute to the protocol implementation, every PR must be opened against `dev` branch. To better understand which is the SRI branches structure, please have a look [here](https://github.com/stratum-mining/stratum/blob/main/RELEASE.md#principal-branches). + Alternatively, you should consider enabling git pre-push hooks: + ``` + $ git config core.hooksPath .githooks + ``` + + This will make your `git push` commands take a bit longer. But it can also save you some time with potential CI issues that could come up in your PR. + +5. **Submit a Pull Request:** once you're satisfied with your changes, submit a pull request to the original SRI repository. Provide a clear and concise description of the changes you've made. If your pull request addresses an existing issue, reference the issue number in the description. In order to contribute to the protocol implementation, every PR must be opened against `main` branch. 6. **Review and Iterate** -7. **Merge and Close:** Once your pull request has been approved and all discussions have been resolved, a project maintainer will merge your changes into the `dev` branch. Your contribution will then be officially part of the project. The pull request will be closed, marking the completion of your contribution. +7. **Merge and Close:** Once your pull request has been approved and all discussions have been resolved, a project maintainer will merge your changes into the `main` branch. Your contribution will then be officially part of the project. The pull request will be closed, marking the completion of your contribution. ### Your First Code Contribution >In order to contribute, a basic learning about git and github is needed. If you're not familiar with them, have a look at https://docs.github.com/en/get-started/start-your-journey/git-and-github-learning-resources to dig into and learn how to use them. diff --git a/README-DEV.md b/README-DEV.md deleted file mode 100644 index 676653e17c..0000000000 --- a/README-DEV.md +++ /dev/null @@ -1,26 +0,0 @@ -# Pushing to the repository -The repository is hosted on GitHub. To push changes to the repository, you need to have a GitHub account and be added -as a collaborator to the repository. You can then push changes to the repository. - -To push to the repository a pre-push hook needs to be run locally to ensure that the code is formatted correctly and -tests pass. To install the pre-push hook run the following command from the root of the repo: - -# Enable pre-push hooks -This tells git where the githooks are located -`# git config core.hooksPath .githooks` - -The githooks rely on the following being install beforehand: - -1. [act](https://github.com/nektos/act) - Github actions local runner. -2. [docker](https://docs.docker.com/get-docker/) - Docker is used to run the act runner. - -Once these are installed the first time you try to push your source to the repo it'll run -./githooks/pre-push script which executes the `sv2_header_check`, `fmt`, `clippy-lint` and `ci` jobs found in the -`.github/workflows` directory. - -# Running the github actions without pushing -You can run the `pre-push` script to run the github actions locally if you want to test out your changes before pushing. -with just `./githooks/pre-push` - -# PR -PRs must be opened against the dev branch not main