Skip to content

Commit

Permalink
Add files via upload
Browse files Browse the repository at this point in the history
Signed-off-by: Christian Kessler <[email protected]>
  • Loading branch information
psyfercom committed Apr 30, 2024
1 parent 1325094 commit ba153eb
Show file tree
Hide file tree
Showing 7 changed files with 428 additions and 0 deletions.
42 changes: 42 additions & 0 deletions BUG_REPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
**Bug Report PR Template**
=====================================



### Bug Information
------------------------

* **Title**: [Provide a clear and descriptive title for the bug]
* **Description**: [Briefly describe the issue you're experiencing,
including any relevant details or steps to reproduce]
* **Steps to Reproduce**:

* Describe the step-by-step process that leads to the bug.

* **Expected Result**: [Describe what you expected to happen instead of
the issue]

### Bug Details
----------------

* **Environment**:
+ **OS**: [Specify your operating system (e.g., Windows, macOS, Linux

Linux)]
+ **Version**: [Specify your operating system version or build
number]
+ **Browser/Tool**: [Specify the browser or tool you're using to repr

reproduce the bug]

### Additional Information
---------------------------

* **Screenshots/Pictures**: [If relevant, provide screenshots or
pictures that demonstrate the issue]
* **Error Messages**: [If applicable, provide any error messages or
console output related to the bug]

---

[Your Name]
63 changes: 63 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
Code of Conduct
===

Hey there! As a community-driven project, we want to make sure everyone
feels welcome and valued when participating in Argochain. To achieve
this, we've created a set of guidelines for behavior and communication
that we call our Code of Conduct.

### Our Principles
-------------------

These principles are based on the [Code of Conduct](https://www.contributor-covenant.org/version/1/0/) by
Contributor Covenant. We're all about:

* **Respect**: Be kind, considerate, and respectful to others. This
means respecting people's time, opinions, and identities.
* **Inclusion**: Make sure everyone feels included and valued in our
community.
* **Openness**: Keep the lines of communication open by listening
actively, asking questions, and clarifying expectations.
* **Fairness**: Treat others fairly and with an open mind. No
assumptions or jumping to conclusions without evidence!

### What You Can Expect
-------------------------

As a member of the Argochain community, you can expect:

* Respectful interactions from others (and us too!)
* Open communication that fosters collaboration and learning
* A welcoming environment where everyone feels valued

### Consequences
-------------------

If someone's behavior is found to be in violation of this Code of
Conduct, we'll take the following steps:

1. **Verbal warning**: We'll give a gentle reminder if someone's
behavior is off-track.
2. **Written warning**: If the behavior continues, we'll send a written
notice.
3. **Temporary suspension**: In extreme cases where the behavior is
severe or persistent, we may temporarily suspend participation in
Argochain activities.
4. **Permanent suspension**: If the behavior causes harm to others and
doesn't improve, we may need to permanently exclude someone from our
community.

### Reporting Incidents
---------------------------

If you experience or witness any incidents that violate this Code of
Conduct, please report them to [reporting contact information]. We'll
handle all reports promptly and fairly.

Thanks for being part of the Argochain community! Let's work together
to create a fun, welcoming environment where everyone feels valued and
can contribute without fear of harassment or discrimination.

---

[Last updated: 2024-04-26]
123 changes: 123 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
# CONTRIBUTING

**Contribution Guidelines**
=====================================================

**Welcome!**
-----------
Argochain is a community-driven, open-source project that aims to
create a secure, decentralized, and transparent platform for building
blockchain-based applications through the use of bleeding edge AI and
machine learning technologies. As a (mostly) open-source project,
we rely on the contributions of passionate individuals like you to help
shape its future.

*Getting Started*
-----------------

### 1. Read Our Code of Conduct
Before you start contributing, please take some time to read our Code
of Conduct. It's essential that all contributors adhere to these
principles to ensure a positive and inclusive environment for everyone
involved in the project.

### 2. Fork the Repository
To contribute, you'll need to fork our repository on GitHub. This will
create a copy of our codebase that you can modify and test
independently.

### 3. Create a New Branch
Once you've forked the repository, create a new branch for your feature
or bug fix. This will make it easier for us to review and merge your
changes.

*Code Style*
------------

### Apache 2 Licensing
All contributions must be licensed under the Apache 2 license. Please
ensure that your code is compatible with this license before submitting
a pull request.

### Consistent Code Formatting
We follow Prettier's formatting guidelines. Make sure to install
Prettier in your IDE or use it as a CLI tool before committing your
code.

### Write Clear and Concise Comments
Please write clear and concise comments to explain the purpose and
functionality of your code. This will make it easier for others to
understand your contributions.

*Reference Our STYLE_GUIDE.md*
---------------------------

For specific guidance on styling, formatting, and coding best
practices, please reference our STYLE_GUIDE.md file. This document
outlines our project's specific coding standards and guidelines for
writing clean, readable, and maintainable code.

*Pull Requests*
-----------------

### Create a Pull Request
When you're ready to contribute, create a pull request against our
`master` branch. Please include a clear description of the changes
you've made and why they're important to the project.

### Test Your Code
Make sure to test your code thoroughly before submitting a pull
request. We want to ensure that all contributions meet our high
standards for quality and reliability.

*Code Review*
-------------

### We'll Review Your Code
Our maintainers will review your pull request, checking for adherence
to our coding standards, functionality, and correctness.

### Respond to Feedback
If we have any questions or concerns about your code, please respond
promptly to feedback and make any necessary changes.

*Acknowledgments*
----------------

### Give Credit Where It's Due
When referencing other projects or libraries in your code, please
include their original authors' names and licenses. This is essential
for maintaining the integrity of our project and respecting the
contributions of others.

### Acknowledge Contributions
We'll acknowledge all contributors on our project's wiki page. Your
name will be proudly displayed alongside those of other passionate
individuals who have helped shape the future of [Project Name].

**Licensing**
------------

### Apache 2 License
All contributions to this project must be licensed under the Apache 2
license.

### GPLv3 Compatibility
As an open-source project, we ensure that our code is compatible with
the GNU General Public License (GPL) version 3. This allows for
seamless integration with other open-source projects and ensures that
our code remains free and accessible for everyone to use, modify, and
distribute.

*Reporting Issues*
-----------------

### Open a GitHub Issue
If you encounter any issues or have questions about contributing to
this project, please create a new issue on our GitHub page. Our
maintainers will respond promptly and work with you to resolve the
issue.

Thank you for considering contributing to [Project Name]! We're excited
to see what you can do. As an open-source project in development, we
rely on passionate individuals like you to help shape its future.
45 changes: 45 additions & 0 deletions FEATURE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
**Feature Proposal PR Template**
=====================================



### Feature Information
-------------------------

* **Title**: [Provide a clear and descriptive title for the feature]


|---|---|
| **Description** |**Use Cases** |
|[Briefly describe the feature you're proposing, including its purpose and how it will benefit users] |[List specific scenarios or examples where this feature would be useful] |



### Technical Details
---------------------

|---|---|
| **API/SDK Changes** |**Implementation Notes** |
|[If applicable, specify any changes to APIs, SDKs, or other technical components that this feature would require] |[Provide any relevant implementation details, such as algorithms, data structures, or testing strategies] |


### Why This Feature is Important
---------------------------------



|---|---|
| **User Benefits** |**Competitive Advantage** |
|[Explain how this feature will improve the user experience and meet their needs] | [Highlight any competitive advantages your project would gain by implementing this feature]|

### Related Issues/PRs
-------------------------

* **Existing Issues**: [List any existing issues or PRs that are
related to this new feature]
* **Similar Features**: [Mention any similar features in other projects
or products that inspired this proposal]

---

[Your Name] [Your Email]
29 changes: 29 additions & 0 deletions QUESTIONS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
**Question PR Template**
=====================================

### Question Information
-------------------------

|---|---|
| **Title**: | [Provide a clear and descriptive title for the question]|
|**Description**: | [Briefly describe the question you have, including any relevant context or background information] |

### Related Context
-------------------

* **Previous Discussions/PRs**: [Link to any previous discussions or
PRs related to this topic]
* **Relevant Documentation**: [Reference any relevant documentation,
such as tutorials, guides, or API specifications]

### Clarification Requested
---------------------------

* **Specific Questions**: [List specific questions you have regarding
the topic]
* **Clarification Needed**: [Explain what clarification or guidance you
need from the maintainers or other contributors]

---

[Your Name] [Your E-mail Here]
9 changes: 9 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Security

Reporting a Vulnerability
This repository is covered by Devolved AI's bug bounty program but until further stated
the

If you have found an issue or bug that potentially affects the overall security of the project then please privately report the issue as a vulnerability on one of the two bug bounty programs below.

Please do not open a public GitHub issue sharing the details of a security related bug. Valid security findings may be eligible for payout. The programs have detailed scopes, so please ensure your bug is within them before submitting.
Loading

0 comments on commit ba153eb

Please sign in to comment.