Merge branch 'main' of https://github.com/RAQ-coin/Raqcoin

Author: Met-AUG

CONTRIBUTING.md

@@ -0,0 +1,159 @@
+Contributing to Raqcoin Core
+============================
+
+The Raqcoin Core project operates an open contributor model where anyone is
+welcome to contribute towards development in the form of peer review, testing
+and patches. This document explains the practical process and guidelines for
+contributing.
+
+Getting Started
+---------------
+
+New contributors are very welcome and needed.
+
+Reviewing and testing is highly valued and the most effective way you can contribute
+as a new contributor. It also will teach you much more about the code and
+process than opening pull requests.
+
+Before you start contributing, familiarize yourself with the Raqcoin Core build
+system and tests. Refer to the documentation in the repository on how to build
+Raqcoin Core and how to run the unit tests.
+
+There are many open issues of varying difficulty waiting to be fixed.
+If you're looking for somewhere to start contributing, check out the
+[good first issue](https://github.com/RAQ-coin/Raqcoin/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
+list or changes that are
+[up for grabs](https://github.com/RAQ-coin/Raqcoin/issues?utf8=%E2%9C%93&q=label%3A%22Up+for+grabs%22).
+Some of them might no longer be applicable. So if you are interested, but
+unsure, you might want to leave a comment on the issue first.
+
+### Good First Issue Label
+
+The purpose of the `good first issue` label is to highlight which issues are
+suitable for a new contributor without a deep understanding of the codebase.
+
+However, good first issues can be solved by anyone. If they remain unsolved
+for a longer time, a frequent contributor might address them.
+
+You do not need to request permission to start working on an issue. However,
+you are encouraged to leave a comment if you are planning to work on it. This
+will help other contributors monitor which issues are actively being addressed
+and is also an effective way to request assistance if and when you need it.
+
+Communication Channels
+----------------------
+
+Most communication about Raqcoin Core development happens on GitHub Issues and Pull Requests.
+
+Contributor Workflow
+--------------------
+
+The codebase is maintained using the "contributor workflow" where everyone
+without exception contributes patch proposals using "pull requests" (PRs). This
+facilitates social contribution, easy testing and peer review.
+
+To contribute a patch, the workflow is as follows:
+
+  1. Fork repository
+  1. Create topic branch
+  1. Commit patches
+  1. Push changes to your fork
+  1. Create pull request
+
+The project coding conventions in [doc/coding.md](doc/coding.md) must be followed.
+
+### Committing Patches
+
+In general, commits should be atomic and diffs should be easy to read. For this reason, do not mix any formatting
+fixes or code moves with actual code changes.
+
+Make sure each individual commit is hygienic: that it builds successfully on its
+own without warnings, errors, regressions, or test failures.
+This means tests must be updated in the same commit that changes the behavior.
+
+Commit messages should be verbose by default consisting of a short subject line
+(50 chars max), a blank line and detailed explanatory text as separate
+paragraph(s), unless the title alone is self-explanatory.
+
+### Creating the Pull Request
+
+The title of the pull request should be prefixed by the component or area that
+the pull request affects. Valid areas as:
+
+  - `consensus` for changes to consensus critical code
+  - `doc` for changes to the documentation
+  - `qt` or `gui` for changes to the GUI
+  - `mining` for changes to the mining code
+  - `net` or `p2p` for changes to the peer-to-peer network code
+  - `refactor` for structural changes that do not change behavior
+  - `test` or `ci` for changes to the unit tests, QA tests or CI code
+  - `util` or `lib` for changes to the utils or libraries
+  - `wallet` for changes to the wallet code
+  - `build` for changes to the build system
+
+The body of the pull request should contain sufficient description of *what* the
+patch does, and even more importantly, *why*, with justification and reasoning.
+
+### Work in Progress Changes and Requests for Comments
+
+If a pull request is not to be considered for merging (yet), please
+prefix the title with [WIP] or use Task Lists
+in the body of the pull request to indicate tasks are pending.
+
+### Address Feedback
+
+At this stage, one should expect comments and review from other contributors. You
+can add more commits to your pull request by committing them locally and pushing
+to your fork.
+
+You are expected to reply to any review comments before your pull request is
+merged. You may update the code or reject the feedback if you do not agree with
+it, but you should express so in a reply. If there is outstanding feedback and
+you are not actively working on it, your pull request may be closed.
+
+Pull Request Philosophy
+-----------------------
+
+Patchsets should always be focused. For example, a pull request could add a
+feature, fix a bug, or refactor code; but not a mixture. Please also avoid super
+pull requests which attempt to do too much, are overly large, or overly complex
+as this makes review difficult.
+
+### Features
+
+When adding a new feature, thought must be given to the long term technical debt
+and maintenance that feature may require after inclusion. Before proposing a new
+feature that will require maintenance, please consider if you are willing to
+maintain it (including bug fixing).
+
+### Refactoring
+
+Refactoring is a necessary part of any software project's evolution.
+Refactoring PRs must not change the behaviour of code within the pull request (bugs must be preserved as is).
+
+"Decision Making" Process
+-------------------------
+
+Whether a pull request is merged into Raqcoin Core rests with the project maintainers.
+
+Maintainers will take into consideration if a patch is in line with the general
+principles of the project; meets the minimum standards for inclusion; and will
+judge the general consensus of contributors.
+
+In general, all pull requests must:
+
+  - Have a clear use case, fix a demonstrable bug or serve the greater good of
+    the project;
+  - Be reviewed;
+  - Have unit tests, where appropriate;
+  - Follow code style guidelines ([doc/coding.md](doc/coding.md));
+  - Not break the existing test suite;
+
+Patches that change Raqcoin consensus rules are considerably more involved than
+normal because they affect the entire ecosystem.
+
+Copyright
+---------
+
+Raqcoin Core is released under the terms of the GNU GPL v. 3 license.
+See [COPYING](COPYING) for more information or https://www.gnu.org/licenses/gpl-3.0.en.html.

QA/QA.md

@@ -0,0 +1 @@
+Q&A

README.md

@@ -16,6 +16,19 @@ software which enables the use of this currency.
 For more information, as well as an immediately useable, binary version of
 the RaqcoinCore client software, see www.Raqcoin.info
 
+Configuration
+-------------
+
+Before starting the application, you need to create a configuration file `raqcoin.conf` in the default data directory:
+
+- **Linux**: `~/.abc/raqcoin.conf`
+- **macOS**: `~/Library/Application Support/abc/raqcoin.conf`
+- **Windows**: `%APPDATA%\abc\raqcoin.conf` (typically `C:\Users\YourUsername\AppData\Roaming\abc\raqcoin.conf`)
+
+You can find a configuration file example at [contrib/debian/examples/raqcoin.conf](contrib/debian/examples/raqcoin.conf).
+
+Alternatively, you can specify a custom data directory using the `-datadir` parameter or a custom configuration file using the `-conf` parameter when starting the application.
+
 License
 -------
 
@@ -24,11 +37,10 @@ RaqcoinCore is released under the terms of the GNU GPL v. 3 license. See https:/
 THIRD PARTY SOFTWARE DISCLOSURE, ATTRIBUTIONS, COPYRIGHT NOTICES, AND LICENSES 
 
 Certain open source third-party software and data components are integrated and/or redistributed with
-ABCMintCore. Such third-party components include terms and conditions, such as attribution and liability disclaimers (collectively "Third Party Disclosures") for which disclosure is required by their respective owners. This notice sets forth such Third Party Disclosures for ABCMintCore. 
+RaqcoinCore. Such third-party components include terms and conditions, such as attribution and liability disclaimers (collectively "Third Party Disclosures") for which disclosure is required by their respective owners. This notice sets forth such Third Party Disclosures for RaqcoinCore. 
 
 RAQCOIN FOUNDATION MAKES NO REPRESENTATION, WARRANTY OR OTHER COMMITMENT REGARDING SUCH THIRD PARTY COMPONENTS.  RAQCOINCORE, AND ALL THIRD PARTY COMPONENTS, ARE DISTRIBUTED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, UNLESS PROHIBITED BY APPLICABLE LAW
 
-
 1. Openssl
 •	Copyright (c) 1998-2018 The OpenSSL Project, all rights reserved
 •	Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson, all rights reserved
@@ -118,15 +130,12 @@ o	   Vadim Barkov
 •	Version:0.2
 •	GPL V3
 
-
-
 Development process
 -------------------
-
 Developers work in their own trees, then submit pull requests when they think
 their feature or bug fix is ready.
 
-If it is a simple/trivial/non-controversial change, then one of the ABCMintCore
+If it is a simple/trivial/non-controversial change, then one of the RaqcoinCore
 development team members simply pulls it.
 
 If it is a *more complicated or potentially controversial* change, then the patch
@@ -139,44 +148,36 @@ match the project's coding conventions (see `doc/coding.md`) or are
 controversial.
 
 The `master` branch is regularly built and tested, but is not guaranteed to be
-completely stable. [Tags](https://github.com/abcmint/abcmint/tags) are created
+completely stable. [Tags](https://github.com/RAQ-coin/Raqcoin/tags) are created
 regularly to indicate new official, stable release versions of Raqcoin.
 
 Testing
 -------
-
 Testing and code review is the bottleneck for development; we get more pull
 requests than we can review and test. Please be patient and help out, and
 remember this is a security-critical project where any mistake might cost people
 lots of money.
 
 ### Automated Testing
-
 Developers are strongly encouraged to write unit tests for new code, and to
 submit new unit tests for old code.
-
 Unit tests for the core code are in `src/test/`. To compile and run them:
-
     cd src; make -f makefile.unix test
-
 Unit tests for the GUI code are in `src/qt/test/`. To compile and run them:
-
     qmake RAQCOIN_QT_TEST=1 -o Makefile.test raqcoin-qt.pro
     make -f Makefile.test
     ./raqcoin-qt_test
-
 Every pull request is built for both Windows and Linux on a dedicated server,
 and unit and sanity tests are automatically run. The binaries produced may be
 used for manual QA testing — a link to them will appear in a comment on the
-pull request posted by (https://github.com/RAQ-coin/). See https://github.com/RAQ-coin/test-scripts
-for the build/test scripts.
+pull request posted by (https://github.com/RAQ-coin/). See https://github.com/RAQ-coin/Raqcoin-test
+for the build/Raqcoin-test.
 
 ### Manual Quality Assurance (QA) Testing
-
 Large changes should have a test plan, and should be tested by somebody other
 than the developer who wrote the code.
 
-See https://github.com/RAQ-coin/QA/ for how to create a test plan.
+See https://github.com/RAQ-coin/Raqcoin-Test/tree/main/QA/ for how to create a test plan.
 
 ### Mining Algorithm Using GPU 
 A new program that can be used to do ABC mining on a GPU is recently release at