generated from cvoges12/app-template
Initial commit
This commit is contained in:
commit
6c550514ad
12 changed files with 946 additions and 0 deletions
79
.gitea/issue_template.md
Normal file
79
.gitea/issue_template.md
Normal file
|
@ -0,0 +1,79 @@
|
|||
---
|
||||
|
||||
name: "Bug"
|
||||
about: "Report a bug to be fixed."
|
||||
title: "[fix]/master "
|
||||
ref: "master"
|
||||
labels:
|
||||
|
||||
- bug
|
||||
- "help wanted"
|
||||
|
||||
---
|
||||
|
||||
### Environment (answer all that apply)
|
||||
|
||||
Operating System (OS) name and version:
|
||||
|
||||
libc name and version:
|
||||
|
||||
Browser name and version:
|
||||
|
||||
Version of each dependency:
|
||||
|
||||
Hardware:
|
||||
|
||||
**\<list any relevant environment variables, software, or other context here>**
|
||||
|
||||
### Expected behavior
|
||||
|
||||
**\<describe the expected behavior here>**
|
||||
|
||||
### Current behavior
|
||||
|
||||
**\<describe the current behavior here>**
|
||||
|
||||
### Steps to Reproduce
|
||||
|
||||
**\<list the steps to reproduce here>**
|
||||
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
...
|
||||
|
||||
### Error messages
|
||||
|
||||
**\<please provide any error messages in code blocks with a label above>**
|
||||
|
||||
**\<message labeling the error>**:
|
||||
```
|
||||
<error message>
|
||||
```
|
||||
|
||||
### Unit tests, Integration tests, or System tests
|
||||
|
||||
**\<please provide any relevant unit tests below>**
|
||||
|
||||
**\<please provide any relevant integration tests below>**
|
||||
|
||||
**\<please provide any relevant system tests below>**
|
||||
|
||||
### Stack trace (if relevant)
|
||||
|
||||
### Logs (if any)
|
||||
|
||||
### Possible solution(s)
|
||||
|
||||
**\<describe any possible solutions here>**
|
||||
|
||||
### If bug is confirmed, are you willing to submit a PR and contribute?
|
||||
|
||||
[ ] yes
|
||||
[ ] no
|
||||
[ ] maybe
|
||||
[ ] what's a PR?
|
||||
|
||||
### Consider funding it!
|
||||
|
||||
<https://www.bountysource.com/>
|
79
.gitea/issue_template/dev_bug.md
Normal file
79
.gitea/issue_template/dev_bug.md
Normal file
|
@ -0,0 +1,79 @@
|
|||
---
|
||||
|
||||
name: "Dev branch Bug"
|
||||
about: "Report a bug to be fixed."
|
||||
title: "[fix]/dev "
|
||||
ref: "dev"
|
||||
labels:
|
||||
|
||||
- bug
|
||||
- "help wanted"
|
||||
|
||||
---
|
||||
|
||||
### Environment (answer all that apply)
|
||||
|
||||
Operating System (OS) name and version:
|
||||
|
||||
libc name and version:
|
||||
|
||||
Browser name and version:
|
||||
|
||||
Version of each dependency:
|
||||
|
||||
Hardware:
|
||||
|
||||
**\<list any relevant environment variables, software, or other context here>**
|
||||
|
||||
### Expected behavior
|
||||
|
||||
**\<describe the expected behavior here>**
|
||||
|
||||
### Current behavior
|
||||
|
||||
**\<describe the current behavior here>**
|
||||
|
||||
### Steps to Reproduce
|
||||
|
||||
**\<list the steps to reproduce here>**
|
||||
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
...
|
||||
|
||||
### Error messages
|
||||
|
||||
**\<please provide any error messages in code blocks with a label above>**
|
||||
|
||||
**\<message labeling the error>**:
|
||||
```
|
||||
<error message>
|
||||
```
|
||||
|
||||
### Unit tests, Integration tests, or System tests
|
||||
|
||||
**\<please provide any relevant unit tests below>**
|
||||
|
||||
**\<please provide any relevant integration tests below>**
|
||||
|
||||
**\<please provide any relevant system tests below>**
|
||||
|
||||
### Stack trace (if relevant)
|
||||
|
||||
### Logs (if any)
|
||||
|
||||
### Possible solution(s)
|
||||
|
||||
**\<describe any possible solutions here>**
|
||||
|
||||
### If bug is confirmed, are you willing to submit a PR and contribute?
|
||||
|
||||
[ ] yes
|
||||
[ ] no
|
||||
[ ] maybe
|
||||
[ ] what's a PR?
|
||||
|
||||
### Consider funding it!
|
||||
|
||||
<https://www.bountysource.com/>
|
39
.gitea/issue_template/feature_request.md
Normal file
39
.gitea/issue_template/feature_request.md
Normal file
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
|
||||
name: "Feature Request"
|
||||
about: "Suggest a feature to be implemented."
|
||||
title: "[FR]/master "
|
||||
ref: "master"
|
||||
labels:
|
||||
|
||||
- enhancement
|
||||
- "help wanted"
|
||||
|
||||
---
|
||||
|
||||
### Detailed Description
|
||||
|
||||
**\<describe what you want the feature to do>**
|
||||
|
||||
### Possible Implementation
|
||||
|
||||
**\<describe how you would implement the feature>**
|
||||
|
||||
### Environment (answer all that apply)
|
||||
|
||||
Operating System (OS) name and version:
|
||||
|
||||
libc name and version:
|
||||
|
||||
Browser name and version:
|
||||
|
||||
Version of each dependency:
|
||||
|
||||
**\<list any relevant environment variables, software, or other context here>**
|
||||
|
||||
### If FR is approved, are you willing to submit a PR and contribute?
|
||||
|
||||
[ ] yes
|
||||
[ ] no
|
||||
[ ] maybe
|
||||
[ ] what's a PR?
|
30
.gitea/issue_template/question.md
Normal file
30
.gitea/issue_template/question.md
Normal file
|
@ -0,0 +1,30 @@
|
|||
---
|
||||
|
||||
name: "Question"
|
||||
about: "Ask a question"
|
||||
title: "[?]/master "
|
||||
ref: "master"
|
||||
labels:
|
||||
|
||||
- question
|
||||
- "help wanted"
|
||||
|
||||
---
|
||||
|
||||
### Environment (answer all that apply)
|
||||
|
||||
Operating System (OS) name and version:
|
||||
|
||||
libc name and version:
|
||||
|
||||
Browser name and version:
|
||||
|
||||
Version of each dependency:
|
||||
|
||||
Hardware:
|
||||
|
||||
**\<list any relevant environment variables, software, or other context here>**
|
||||
|
||||
### Question
|
||||
|
||||
**\<ask your question here>**
|
31
.gitea/pull_request_template.md
Normal file
31
.gitea/pull_request_template.md
Normal file
|
@ -0,0 +1,31 @@
|
|||
---
|
||||
|
||||
name: "Default"
|
||||
about: "Default pull request template"
|
||||
title: "PR/master: "
|
||||
ref: "master"
|
||||
labels:
|
||||
|
||||
---
|
||||
|
||||
|
||||
### Description
|
||||
|
||||
### Related issue
|
||||
|
||||
### Motivation and Context
|
||||
|
||||
### How has this been tested?
|
||||
|
||||
### Screenshots (if appropriate)
|
||||
|
||||
### Type of change
|
||||
|
||||
[ ] Bug fix or patch (non-breaking fix of an issue: v_._.X)
|
||||
[ ] New feature (non-breaking adding functionality: v_.X._)
|
||||
[ ] Breaking change (fix or feature that breaks existing functionality: vX._._)
|
||||
|
||||
### Have you read our CODE_OF_CONDUCT.md, CONTRIBUTING.md, and other documents?
|
||||
|
||||
[ ] yes
|
||||
[ ] no
|
235
LICENSE
Normal file
235
LICENSE
Normal file
|
@ -0,0 +1,235 @@
|
|||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software.
|
||||
|
||||
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, our General Public Licenses are intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
|
||||
|
||||
Developers that use our General Public Licenses protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License which gives you legal permission to copy, distribute and/or modify the software.
|
||||
|
||||
A secondary benefit of defending all users' freedom is that improvements made in alternate versions of the program, if they receive widespread use, become available for other developers to incorporate. Many developers of free software are heartened and encouraged by the resulting cooperation. However, in the case of software used on network servers, this result may fail to come about. The GNU General Public License permits making a modified version and letting the public access it on a server without ever releasing its source code to the public.
|
||||
|
||||
The GNU Affero General Public License is designed specifically to ensure that, in such cases, the modified source code becomes available to the community. It requires the operator of a network server to provide the source code of the modified version running there to the users of that server. Therefore, public use of a modified version, on a publicly accessible server, gives the public access to the source code of the modified version.
|
||||
|
||||
An older license, called the Affero General Public License and published by Affero, was designed to accomplish similar goals. This is a different license, not a version of the Affero GPL, but Affero has released a new version of the Affero GPL which permits relicensing under this license.
|
||||
|
||||
The precise terms and conditions for copying, distribution and modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU Affero General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
"Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the Program, your modified version must prominently offer all users interacting with it remotely through a computer network (if your version supports such interaction) an opportunity to receive the Corresponding Source of your version by providing access to the Corresponding Source from a network server at no charge, through some standard or customary means of facilitating copying of software. This Corresponding Source shall include the Corresponding Source for any work covered by version 3 of the GNU General Public License that is incorporated pursuant to the following paragraph.
|
||||
|
||||
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the work with which it is combined will remain governed by version 3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of the GNU Affero General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU Affero General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU Affero General Public License, you may choose any version ever published by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future versions of the GNU Affero General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If your software can interact with users remotely through a computer network, you should also make sure that it provides a way for users to get its source. For example, if your program is a web application, its interface could display a "Source" link that leads users to an archive of the code. There are many ways you could offer source, and different solutions will be better for different programs; see section 13 for the specific requirements.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU AGPL, see <http://www.gnu.org/licenses/>.
|
262
README.md
Normal file
262
README.md
Normal file
|
@ -0,0 +1,262 @@
|
|||
<h1 align="center">
|
||||
<a href="https://gitdab.com/cvoges12/Sync-Repos">
|
||||
<img src="docs/images/logo.png" alt="Logo" width="100" height="100">
|
||||
</a>
|
||||
<br />
|
||||
Sync-Repos
|
||||
</h1>
|
||||
|
||||
> **[?]**
|
||||
> Switch for your own logo
|
||||
|
||||
<div align="center">
|
||||
<i>A simple Git repository synchronization tool</i>
|
||||
<br />
|
||||
<a href="https://gitdab.com/cvoges12/Sync-Repos/issues/new">
|
||||
Report a Bug
|
||||
</a>
|
||||
·
|
||||
<a href="https://gitdab.com/cvoges12/Sync-Repos/issues/new?template=feature_request.md">
|
||||
Request a Feature
|
||||
</a>
|
||||
·
|
||||
<a href="https://gitdab.com/cvoges12/Sync-Repos/issues/new?template=question.md">
|
||||
Ask a Question
|
||||
</a>
|
||||
<br />
|
||||
|
||||
[![Project license](https://img.shields.io/badge/license-AGPL--3.0--only-green?style=flat-square)](LICENSE)
|
||||
|
||||
[![Pull Requests welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg?style=flat-square)](https://gitdab.com/cvoges12/Sync-Repos/compare)
|
||||
[![code with love by](https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%99%A5%20by-cvoges12-ff1414.svg?style=flat-square)](https://gitdab.com/cvoges12)
|
||||
|
||||
Donations accepted:
|
||||
<br />
|
||||
[![Liberapay receiving](https://img.shields.io/liberapay/receives/cvoges12.svg?style=flat-square)](https://liberapay.com/cvoges12)
|
||||
[![buymeacoffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://buymeacoffee.com/cvoges12)
|
||||
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/cvoges12)
|
||||
|
||||
</div>
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [About](#about)
|
||||
- [Getting Started](#getting-started)
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [Installation](#installation)
|
||||
- [Usage](#usage)
|
||||
- [Support](#support)
|
||||
- [Roadmap](#roadmap)
|
||||
- [Project Help](#project-help)
|
||||
- [Contributing](#contributing)
|
||||
- [Acknowledgements](#acknowledgements)
|
||||
- [Funding Organizations](#funding-organizations)
|
||||
- [Patrons](#patrons)
|
||||
- [Software Used](#software-used)
|
||||
- [Inspirations](#inspirations)
|
||||
- [Authors and Contributors](#authors-and-contributors)
|
||||
- [Security](#security)
|
||||
- [License](#license)
|
||||
|
||||
## About
|
||||
|
||||
> **[?]**
|
||||
> Provide general information about your project here.
|
||||
> What problem does it (intend to) solve?
|
||||
> What is the purpose of your project?
|
||||
> Why did you undertake it?
|
||||
|
||||
**[Back to top](#table-of-contents)**
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
Required dependencies:
|
||||
- .
|
||||
|
||||
> **[?]**
|
||||
> List project requirements or dependencies.
|
||||
> List build tools.
|
||||
|
||||
**[Back to top](#table-of-contents)**
|
||||
|
||||
### Installation
|
||||
|
||||
Run the following to install:
|
||||
```sh
|
||||
```
|
||||
|
||||
> **[?]**
|
||||
> Describe how to install and get started with the project.
|
||||
> List build instructions.
|
||||
|
||||
**[Back to top](#table-of-contents)**
|
||||
|
||||
## Usage
|
||||
|
||||
> **[?]**
|
||||
> How does one go about using it?
|
||||
> Provide various use cases and code examples here.
|
||||
|
||||
**[Back to top](#table-of-contents)**
|
||||
|
||||
## Support
|
||||
|
||||
> **[?]**
|
||||
> Provide additional ways to contact the project maintainer/maintainers.
|
||||
> Website?
|
||||
> Email?
|
||||
|
||||
**[Back to top](#table-of-contents)**
|
||||
|
||||
## Roadmap
|
||||
|
||||
See the [open issues](https://gitdab.com/cvoges12/Sync-Repos/issues)
|
||||
for a list of proposed features (and known issues).
|
||||
|
||||
For some quick links:
|
||||
- [Top Feature Requests](https://gitdab.com/cvoges12/Sync-Repos/issues?state=open&sort=mostcomment&labels=)
|
||||
- [Newest Feature Requests](https://gitdab.com/cvoges12/Sync-Repos/issues?state=open&sort=latest&labels=)
|
||||
- [Hottest Feature Requests](https://gitdab.com/cvoges12/Sync-Repos/issues?state=open&sort=mostcomment&labels=)
|
||||
- [Top Bugs](https://gitdab.com/cvoges12/Sync-Repos/issues?state=open&sort=mostcommented&labels=)
|
||||
- [Newest Bugs](https://gitdab.com/cvoges12/Sync-Repos/issues?state=open&sort=latest&labels=)
|
||||
- [Hottest Bugs](https://gitdab.com/cvoges12/Sync-Repos/issues?state=open&sort=mostcomment&labels=)
|
||||
|
||||
> **[?]**
|
||||
> Add number to `labels=` in link.
|
||||
> Add Kanban board or other project management software.
|
||||
|
||||
**[Back to top](#table-of-contents)**
|
||||
|
||||
## Project Help
|
||||
|
||||
If you want to say "thank you" and/or support active development of
|
||||
**Sync-Repos**:
|
||||
- Add a [GitHub Star](https://github.com/cvoges12/Sync-Repos) to the
|
||||
project's GitHub awareness page. (*our project is not mirrored to prevent
|
||||
GitHub Copilot*)
|
||||
- Tweet about Sync-Repos or spread the word on other social media.
|
||||
- Write interesting articles about the project on [Dev.to](https://dev.to/),
|
||||
[Medium](https://medium.com/), or your personal blog.
|
||||
- Become a patron and help fund **Sync-Repos**:
|
||||
- [Liberapay](https://liberapay.com/cvoges12)
|
||||
- [Buy me a coffee](https://www.buymeacoffee.com/cvoges12)
|
||||
- [Ko-Fi](https://ko-fi.com/cvoges12)
|
||||
|
||||
> **[?]**
|
||||
> Replace the above links with links to the project's own funding pages.
|
||||
|
||||
> **[?]**
|
||||
> Optionally, add other donation links, such as:
|
||||
> Patreon,
|
||||
> Kickstarter,
|
||||
> Indiegogo
|
||||
|
||||
Together, we can make Sync-Repos **better**!
|
||||
|
||||
**[Back to top](#table-of-contents)**
|
||||
|
||||
## Contributing
|
||||
|
||||
Firstly, thanks for considering to contribute!
|
||||
Contributions are what make the open-source community such an amazing place to
|
||||
learn, inspire, and create.
|
||||
Any contributions you make will benefit everybody else and are **greatly
|
||||
appreciated**.
|
||||
|
||||
Please read [our contribution guidelines](docs/CONTRIBUTING.md), and thank you
|
||||
for being involved!
|
||||
|
||||
**[Back to top](#table-of-contents)**
|
||||
|
||||
## Acknowledgements
|
||||
|
||||
### Funding Organizations
|
||||
|
||||
> **[?]**
|
||||
> Include any organizations or companies that are funding the project.
|
||||
|
||||
**[Back to top](#table-of-contents)**
|
||||
|
||||
### Patrons
|
||||
|
||||
A special thanks to my patrons on:
|
||||
- [Liberapay](https://liberapay.com/cvoges12)
|
||||
- [Buy me a coffee](https://www.buymeacoffee.com/cvoges12)
|
||||
- [Ko-Fi](https://ko-fi.com/cvoges12)
|
||||
|
||||
> **[?]**
|
||||
> Replace the above links with links to the project's own funding pages w/
|
||||
> patrons listed.
|
||||
|
||||
> **[?]**
|
||||
> Optionally, add other donation links, such as:
|
||||
> Patreon,
|
||||
> Kickstarter,
|
||||
> Indiegogo
|
||||
|
||||
**[Back to top](#table-of-contents)**
|
||||
|
||||
### Software Used
|
||||
|
||||
- The
|
||||
[Amazing Github Template](https://github.com/dec0dOS/amazing-github-template)
|
||||
for the README.md and some other documents.
|
||||
- The [cvoges12 app-template](https://gitdab.com/cvoges12/app-template) for this template repository.
|
||||
|
||||
> **[?]**
|
||||
> Include libraries and applications used in the project.
|
||||
|
||||
**[Back to top](#table-of-contents)**
|
||||
|
||||
### Inspirations
|
||||
|
||||
> **[?]**
|
||||
> Include any projects or people that have inspired this project.
|
||||
|
||||
**[Back to top](#table-of-contents)**
|
||||
|
||||
### Authors and contributors
|
||||
|
||||
The original setup of this repository is by cvoges12.
|
||||
|
||||
For a full list of all authors and contributors, see
|
||||
[the contributors page](https://gitdab.com/cvoges12/Sync-Repos/activity).
|
||||
|
||||
> **[?]**
|
||||
> Replace with contributors graph once
|
||||
> https://github.com/go-gitea/gitea/issues/847
|
||||
> is implemented.
|
||||
|
||||
**[Back to top](#table-of-contents)**
|
||||
|
||||
## Security
|
||||
|
||||
**Sync-Repos** follows good practices of security, but 100% security cannot
|
||||
be assured.
|
||||
**Sync-Repos** is provided **"as is"** without any **warranty**. Use at your
|
||||
own risk.
|
||||
|
||||
_For more information and to report security issues, please refer to our
|
||||
[security documentation](docs/SECURITY.md)._
|
||||
|
||||
**[Back to top](#table-of-contents)**
|
||||
|
||||
## License
|
||||
|
||||
Copyright (C) 2022 Clayton Voges
|
||||
|
||||
This program is free software: you can redistribute it and/or modify it under
|
||||
the terms of the GNU Affero General Public License as published by the Free
|
||||
Software Foundation, version 3.
|
||||
|
||||
This program is distributed in the hope that it will be useful, but WITHOUT
|
||||
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
||||
FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
|
||||
details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License along
|
||||
with this program. If not, see <https://www.gnu.org/licenses/>
|
||||
|
||||
**[Back to top](#table-of-contents)**
|
85
docs/CODE_OF_CONDUCT.md
Normal file
85
docs/CODE_OF_CONDUCT.md
Normal file
|
@ -0,0 +1,85 @@
|
|||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as
|
||||
contributors and maintainers pledge to make participation in our project and
|
||||
our community a harassment-free experience for everyone, regardless of age,
|
||||
body size, disability, ethnicity, sex characteristics, gender identity and
|
||||
expression, level of experience, education, socio-economic status,
|
||||
nationality, personal appearance, race, religion, or sexual identity and
|
||||
orientation.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment
|
||||
include:
|
||||
|
||||
* Using welcoming and inclusive language
|
||||
* Being respectful of differing viewpoints and experiences
|
||||
* Gracefully accepting constructive criticism
|
||||
* Focusing on what is best for the community
|
||||
* Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
* The use of sexualized language or imagery and unwelcome sexual attention or
|
||||
advances
|
||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
* Spam
|
||||
* Public or private "harassment" as including the definition in the
|
||||
[Citizen Code of Conduct](https://web.archive.org/web/20200330154000/http://citizencodeofconduct.org/); if you have
|
||||
any lack of clarity about what might be included in that concept, please
|
||||
read their definition.
|
||||
* Publishing others' private information, such as a physical or electronic
|
||||
address, without explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Our Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of
|
||||
acceptable behavior and are expected to take appropriate and fair corrective
|
||||
action in response to any instances of unacceptable behavior.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or
|
||||
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||
that are not aligned to this Code of Conduct, or to ban temporarily or
|
||||
permanently any contributor for other behaviors that they deem inappropriate,
|
||||
threatening, offensive, or harmful.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies within all project spaces, and it also applies
|
||||
when an individual is representing the project or its community in public
|
||||
spaces.
|
||||
Examples of representing a project or community include using an official
|
||||
project email address, posting via an official social media account, or
|
||||
acting as an appointed representative at an online or offline event.
|
||||
Representation of a project may be further defined and clarified by project
|
||||
maintainers.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported by contacting the project maintainer using any of the
|
||||
[private contact addresses](https://gitdab.com/cvoges12/Sync-Repos#support).
|
||||
All complaints will be reviewed, investigated, and will result in a
|
||||
response that is deemed necessary and appropriate to the circumstances.
|
||||
The project team is obligated to maintain confidentiality with regard to the
|
||||
reporter of an incident.
|
||||
Further details of specific enforcement policies may be posted separately.
|
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good
|
||||
faith may face temporary or permanent repercussions as determined by other
|
||||
members of the project's leadership.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the
|
||||
[Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
|
||||
available at
|
||||
<https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>.
|
||||
|
||||
For answers to common questions about this code of conduct, see
|
||||
<https://www.contributor-covenant.org/faq>.
|
90
docs/CONTRIBUTING.md
Normal file
90
docs/CONTRIBUTING.md
Normal file
|
@ -0,0 +1,90 @@
|
|||
# Contributing
|
||||
|
||||
When contributing to this repository, please first discuss the change you
|
||||
wish to make via issue, email, or any other method with the owners of this
|
||||
repository before making a change.
|
||||
|
||||
Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it
|
||||
in all your interactions with the project.
|
||||
|
||||
## Request for contributions
|
||||
|
||||
Please contribute to this repository if any of the following is true:
|
||||
- You have expertise in community development, communication, or education
|
||||
- You want open source communities to be more collaborative and inclusive
|
||||
- You want to help lower the burden to first time contributors
|
||||
|
||||
## Contributions
|
||||
|
||||
Prerequisites:
|
||||
|
||||
- Familiarity with
|
||||
[pull requests](https://help.github.com/articles/using-pull-requests) and
|
||||
[issues](https://guides.github.com/features/issues/).
|
||||
- Knowledge of [Markdown](https://help.github.com/articles/markdown-basics/)
|
||||
for editing `.md` documents.
|
||||
|
||||
In particular, this community seeks the following types of contributions:
|
||||
|
||||
- **Ideas**: participate in an issue thread or start your own to have your
|
||||
voice heard.
|
||||
- **Resources**: submit a pull request to add to
|
||||
[RESOURCES.md](docs/RESOURCES.md) with links to related content.
|
||||
- **Outline sections**: help us ensure that this repository is comprehensive.
|
||||
If there is a topic that is overlooked, please add it, even if it is just
|
||||
a stub in the form of a header and single sentence.
|
||||
Initially, most things fall into this category.
|
||||
- **Writing**: contribute your expertise in an area by helping us expand the
|
||||
included content.
|
||||
- **Copy editing**: fix typos, clarify language, and generally improve the
|
||||
quality of the content.
|
||||
- **Formatting**: help keep content easy to read with consistent formatting.
|
||||
|
||||
|
||||
## Development environment setup
|
||||
|
||||
> **[?]**
|
||||
> Proceed to describe how to setup local development environment.
|
||||
> e.g:
|
||||
|
||||
To set up a development environment, please follow these steps:
|
||||
|
||||
1. Clone the repo
|
||||
|
||||
```sh
|
||||
git clone https://github.com/cvoges12/Sync-Repos
|
||||
```
|
||||
|
||||
2. TODO
|
||||
|
||||
## Issues and feature requests
|
||||
|
||||
Have you found a bug in the source code, a mistake in the documentation, or
|
||||
maybe you'd like a new feature?
|
||||
You can help us by
|
||||
[submitting an issue](https://gitdab.com/cvoges12/Sync-Repos/issues).
|
||||
Before you create an issue, make sure to search the issue archive -- your
|
||||
issue may have already been addressed!
|
||||
|
||||
Please try to create bug reports that are:
|
||||
|
||||
- _Reproducible._ Include steps to reproduce the problem.
|
||||
- _Specific._ Include as much detail as possible: which version, what environment, etc.
|
||||
- _Unique._ Do not duplicate existing opened issues.
|
||||
- _Scoped to a Single Bug._ One bug per report.
|
||||
|
||||
**Even better: Submit a pull request with a fix or new feature!**
|
||||
|
||||
### How to submit a Pull Request
|
||||
|
||||
1. Search our repository for open or closed
|
||||
[Pull Requests](https://gitdab.com/cvoges12/Sync-Repos/pulls)
|
||||
that relate to your submission.
|
||||
You don't want to duplicate effort.
|
||||
2. Fork the project.
|
||||
3. Create your feature branch (`git checkout -b feat/amazing_feature`).
|
||||
4. Commit your changes (`git commit -m 'feat: add amazing_feature'`) uses
|
||||
[conventional commits](https://www.conventionalcommits.org), so please
|
||||
follow the specification in your commit messages.
|
||||
5. Push to the branch (`git push origin feat/amazing_feature`)
|
||||
6. [Open a Pull Request](https://gitdab.com/cvoges12/Sync-Repos/compare)
|
0
docs/RESOURCES.md
Normal file
0
docs/RESOURCES.md
Normal file
16
docs/SECURITY.md
Normal file
16
docs/SECURITY.md
Normal file
|
@ -0,0 +1,16 @@
|
|||
# Security Policy
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
If there are any vulnerabilities in **Sync-Repos**, don't hesitate to _report them_.
|
||||
|
||||
1. Use any of the [private contact addresses](https://gitdab.com/cvoges12/Sync-Repos#support).
|
||||
2. Describe the vulnerability.
|
||||
|
||||
If you have a fix, that is most welcome -- please attach or summarize it in your message!
|
||||
|
||||
3. We will evaluate the vulnerability and, if necessary, release a fix or mitigating steps to address it. We will contact you to let you know the outcome, and will credit you in the report.
|
||||
|
||||
Please **do not disclose the vulnerability publicly** until a fix is released!
|
||||
|
||||
4. Once we have either a) published a fix, or b) declined to address the vulnerability for whatever reason, you are free to publicly disclose it.
|
BIN
docs/images/logo.png
Normal file
BIN
docs/images/logo.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 60 KiB |
Loading…
Reference in a new issue