From 3de76dbb10255cb72b31ac73d8c10250120aa134 Mon Sep 17 00:00:00 2001 From: HyperWinX Date: Sun, 6 Apr 2025 23:00:53 +0400 Subject: [PATCH 1/3] Add CONTRIBUTION.md --- CONTRIBUTION.md | 10 ++++++++++ README.md | 11 +---------- 2 files changed, 11 insertions(+), 10 deletions(-) create mode 100644 CONTRIBUTION.md diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md new file mode 100644 index 00000000..7d00ef6a --- /dev/null +++ b/CONTRIBUTION.md @@ -0,0 +1,10 @@ +# How to contribute to HyperCPU project + +## For collabolators: +1. Clone repository locally +2. Create new branch from the branch `master`. Think about the name - what feature are you going to add? Or are you going to fix something? +3. Work on that branch, DO NOT touching others. Every push in a non-master branch runs a CI workflow with minimal tests. +4. When the feature is ready - make a pull request to the master branch. When the PR gets created, you have to track following checks: `CodeQL`, `Codacy`, main CI workflow, that runs extended tests, and the job that builds the project on multiple distributions. Wait for the project owner to review changes and approve. In case, if MentatBot will tell you what you can improve - you better improve it:) When all CI jobs will finish successfully, wait for repository owner to merge your PR. Voila - your feature has been merged! Well done! + +## For other contributors +1. Almost the same thing as for collabolators, BUT - you have to fork the repository, and work there. Notice, that you probably have to disable GitHub Actions, or connect the self-hosted runner (no guarantee that HyperCPU workflows will execute successfully on custom runner). When you are ready to send your changes - make a PR - and there goes the same cycle, until the PR gets merged:) \ No newline at end of file diff --git a/README.md b/README.md index 40d3280e..88f1ca79 100644 --- a/README.md +++ b/README.md @@ -142,21 +142,12 @@ To display program version and exit: $ ./hcemul --version ``` -### Build status -## Supported Distributions - -| Distribution | Build Status | -|-----------------|--------------| -| Fedora | [![Fedora Build Status](https://img.shields.io/github/actions/workflow/status/HyperWinX/HyperCPU/distro-ci.yml?label=Fedora&jobName=Build-Fedora)](https://github.com/HyperWinX/HyperCPU/actions/workflows/distro-ci.yml) | -| Debian Stable | [![Debian Stable Build Status](https://img.shields.io/github/actions/workflow/status/HyperWinX/HyperCPU/distro-ci.yml?label=Debian%20Stable&jobName=Build-Debian-Stable)](https://github.com/HyperWinX/HyperCPU/actions/workflows/distro-ci.yml) | -| Debian Unstable | [![Debian Unstable Build Status](https://img.shields.io/github/actions/workflow/status/HyperWinX/HyperCPU/distro-ci.yml?label=Debian%20Unstable&jobName=Build-Debian-Unstable)](https://github.com/HyperWinX/HyperCPU/actions/workflows/distro-ci.yml) | ### Contributing HyperCPU is in active development and we will be happy to hear any feedback from you. Do not hesitate to report bugs or suggest any ideas using "Issues" page. ->[!IMPORTANT] -> Please send your pull requests to `dev` repository branch, not `master`. +See how you can contribute in [CONTRIBUTION.MD](CONTRIBUTION.md). Thank you for your interest in HyperCPU. From a8af292fc3bc27bf16973cb8d5ba836e963c7259 Mon Sep 17 00:00:00 2001 From: HyperWin <92534013+HyperWinX@users.noreply.github.com> Date: Mon, 7 Apr 2025 00:14:51 +0400 Subject: [PATCH 2/3] Fix typo --- CONTRIBUTION.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md index 7d00ef6a..ca408fee 100644 --- a/CONTRIBUTION.md +++ b/CONTRIBUTION.md @@ -1,6 +1,6 @@ # How to contribute to HyperCPU project -## For collabolators: +## For collaborators: 1. Clone repository locally 2. Create new branch from the branch `master`. Think about the name - what feature are you going to add? Or are you going to fix something? 3. Work on that branch, DO NOT touching others. Every push in a non-master branch runs a CI workflow with minimal tests. From aab156925aa77d17b172be4bc3e1a1d4035b1332 Mon Sep 17 00:00:00 2001 From: HyperWin <92534013+HyperWinX@users.noreply.github.com> Date: Mon, 7 Apr 2025 00:17:59 +0400 Subject: [PATCH 3/3] Add blank lines before tables [codacy] --- CONTRIBUTION.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md index ca408fee..9311d8fc 100644 --- a/CONTRIBUTION.md +++ b/CONTRIBUTION.md @@ -1,10 +1,12 @@ # How to contribute to HyperCPU project ## For collaborators: + 1. Clone repository locally 2. Create new branch from the branch `master`. Think about the name - what feature are you going to add? Or are you going to fix something? 3. Work on that branch, DO NOT touching others. Every push in a non-master branch runs a CI workflow with minimal tests. 4. When the feature is ready - make a pull request to the master branch. When the PR gets created, you have to track following checks: `CodeQL`, `Codacy`, main CI workflow, that runs extended tests, and the job that builds the project on multiple distributions. Wait for the project owner to review changes and approve. In case, if MentatBot will tell you what you can improve - you better improve it:) When all CI jobs will finish successfully, wait for repository owner to merge your PR. Voila - your feature has been merged! Well done! ## For other contributors + 1. Almost the same thing as for collabolators, BUT - you have to fork the repository, and work there. Notice, that you probably have to disable GitHub Actions, or connect the self-hosted runner (no guarantee that HyperCPU workflows will execute successfully on custom runner). When you are ready to send your changes - make a PR - and there goes the same cycle, until the PR gets merged:) \ No newline at end of file