Skip to content

Commit

Permalink
Merge branch 'master' into spark
Browse files Browse the repository at this point in the history
  • Loading branch information
levonpetrosyan93 committed Jul 15, 2023
2 parents ce29de5 + 26da759 commit ede060b
Show file tree
Hide file tree
Showing 19 changed files with 256 additions and 339 deletions.
37 changes: 0 additions & 37 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: Bug
about: Bug or problem that needs to be fixed
---

<!-- Before opening an issue, make sure there isn't already an open one related to your problem -->

### Describe the issue

### Local setup
<!-- Operative system, Firo version, etc -->

### Any extra information that might be useful in the debugging process.
6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/general.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
name: General
about: Open a general issue or feature request
---

<!-- This issue tracker is for technical matters only. If you have generic questions about Firo, contact the community: https://firo.org/community/social/ -->
37 changes: 0 additions & 37 deletions .github/issue_template.md

This file was deleted.

48 changes: 21 additions & 27 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
Contributing to Bitcoin Core
============================
# Contributing to Firo

The Bitcoin Core project operates an open contributor model where anyone is
The Firo 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.
Expand All @@ -15,8 +14,7 @@ merging pull requests as well as a "lead maintainer" who is responsible for the
release cycle, overall merging, moderation and appointment of maintainers.


Contributor Workflow
--------------------
## Contributor Workflow

The codebase is maintained using the "contributor workflow" where everyone
without exception contributes patch proposals using "pull requests". This
Expand Down Expand Up @@ -57,12 +55,12 @@ the pull request affects. Valid areas as:

- *Consensus* for changes to consensus critical code
- *Docs* for changes to the documentation
- *Qt* for changes to bitcoin-qt
- *Qt* for changes to firo-qt
- *Mining* for changes to the mining code
- *Net* or *P2P* for changes to the peer-to-peer network code
- *RPC/REST/ZMQ* for changes to the RPC, REST or ZMQ APIs
- *Scripts and tools* for changes to the scripts and tools
- *Tests* for changes to the bitcoin unit tests or QA tests
- *Tests* for changes to the firo unit tests or QA tests
- *Trivial* should **only** be used for PRs that do not change generated
executable code. Notably, refactors (change of function arguments and code
reorganization) and changes in behavior should **not** be marked as trivial.
Expand Down Expand Up @@ -94,8 +92,8 @@ 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 until you have satisfied all feedback.

Squashing Commits
---------------------------
## Squashing Commits

If your pull request is accepted for merging, you may be asked by a maintainer
to squash and or [rebase](https://git-scm.com/docs/git-rebase) your commits
before it will be merged. The basic squashing workflow is shown below.
Expand All @@ -121,16 +119,15 @@ The length of time required for peer review is unpredictable and will vary from
pull request to pull request.


Pull Request Philosophy
-----------------------
## 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
## 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
Expand All @@ -139,7 +136,7 @@ maintain it (including bug fixing). If features get orphaned with no maintainer
in the future, they may be removed by the Repository Maintainer.


###Refactoring
## Refactoring

Refactoring is a necessary part of any software project's evolution. The
following guidelines cover refactoring pull requests for the project.
Expand All @@ -154,14 +151,13 @@ Project maintainers aim for a quick turnaround on refactoring pull requests, so
where possible keep them short, uncomplex and easy to verify.


"Decision Making" Process
-------------------------
## "Decision Making" Process

The following applies to code changes to the Bitcoin Core project (and related
projects such as libsecp256k1), and is not to be confused with overall Bitcoin
The following applies to code changes to the Firo project (and related
projects such as libsecp256k1), and is not to be confused with overall Firo
Network Protocol consensus changes.

Whether a pull request is merged into Bitcoin Core rests with the project merge
Whether a pull request is merged into Firo rests with the project merge
maintainers and ultimately the project lead.

Maintainers will take into consideration if a patch is in line with the general
Expand All @@ -179,15 +175,15 @@ In general, all pull requests must:
- where bugs are fixed, where possible, there should be unit tests
demonstrating the bug and also proving the fix. This helps prevent regression.

Patches that change Bitcoin consensus rules are considerably more involved than
Patches that change Firo consensus rules are considerably more involved than
normal because they affect the entire ecosystem and so must be preceded by
extensive mailing list discussions and have a numbered BIP. While each case will
be different, one should be prepared to expend more time and effort than for
other kinds of patches because of increased peer review and consensus building
requirements.


###Peer Review
## Peer Review

Anyone may participate in peer review which is expressed by comments in the pull
request. Typically reviewers will review the code for obvious errors, as well as
Expand Down Expand Up @@ -220,21 +216,19 @@ higher in terms of discussion and peer review requirements, keeping in mind that
mistakes could be very costly to the wider community. This includes refactoring
of consensus critical code.

Where a patch set proposes to change the Bitcoin consensus, it must have been
Where a patch set proposes to change the Firo consensus, it must have been
discussed extensively on the mailing list and IRC, be accompanied by a widely
discussed BIP and have a generally widely perceived technical consensus of being
a worthwhile change based on the judgement of the maintainers.


Release Policy
--------------
## Release Policy

The project leader is the release manager for each Bitcoin Core release.
The project leader is the release manager for each Firo release.

Copyright
---------
## Copyright

By contributing to this repository, you agree to license your work under the
MIT license unless specified otherwise in `contrib/debian/copyright` or at
MIT license unless specified otherwise in `COPYING` or at
the top of the file itself. Any work contributed where you are not the original
author must contain its license header with the original author(s) and source.
4 changes: 3 additions & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,9 @@ COPY --from=build-image /usr/bin/firo-cli /usr/bin/firo-cli
COPY --from=build-image /tmp/ldd /tmp/ldd

# restore ldd files in correct paths
RUN cp --verbose -RT /tmp/ldd / && \
# -n will not override libraries already present in this image,
# standard libraries like `libc` can crash when overriden at runtime
RUN cp -vnrT /tmp/ldd / && \
rm -rf /tmp/ldd && \
ldd /usr/bin/firod

Expand Down
5 changes: 0 additions & 5 deletions INSTALL.md

This file was deleted.

Loading

0 comments on commit ede060b

Please sign in to comment.