Skip to content

Commit

Permalink
Merge branch 'main' into feat/network-app
Browse files Browse the repository at this point in the history
  • Loading branch information
Ehsan-saradar committed Feb 12, 2024
2 parents 1912914 + 511082c commit 9a9334e
Show file tree
Hide file tree
Showing 81 changed files with 13,446 additions and 5,883 deletions.
2 changes: 2 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@

# Docs
*.md @ilgooz

LICENSE @ilgooz
5 changes: 2 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
.idea
.vscode
*.test
*.app
*.ign
go.work
hermes/hermes
explorer/explorer
go.work.sum
2 changes: 1 addition & 1 deletion .golangci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ linters:
enable:
- bodyclose
- decorder
- depguard
#- depguard
- dogsled
- dupword
- errchkjson
Expand Down
43 changes: 43 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, 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
- Public or private harassment
- 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 both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail 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 team. All complaints will be reviewed and 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
74 changes: 74 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Contributing to Ignite Apps

We warmly welcome contributions to the Ignite Apps project! This document provides guidelines for contributing to the Ignite Apps repository. By following these guidelines, you can help us maintain a healthy and sustainable open-source ecosystem.

## Code of Conduct

This project and everyone participating in it is governed by the [Ignite Apps Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to the team.

## How to Contribute

### Reporting Bugs

Before submitting a bug report, please check if the issue has already been reported. If it has not, create a new issue and include:

- A clear title and description.
- As much relevant information as possible (e.g., version, environment).
- A code sample or an executable test case demonstrating the expected behavior that is not occurring.

### Suggesting Enhancements

Enhancement suggestions are also welcome. Open an issue and include:

- A clear title and description of the enhancement.
- Explain why this enhancement would be useful.
- Provide a use case or code examples if possible.

### Pull Requests

1. Fork the repository and create your branch from `main`.
2. If you've added code that should be tested, add tests.
3. Ensure your code adheres to the existing style in the project to maintain consistency.
4. Write clear, meaningful commit messages.
5. Include appropriate tests.
6. Add or update the documentation as necessary.
7. After submitting your pull request, verify that all status checks are passing.

### Development Setup

For setting up your local development environment, follow these steps:

```bash
# Clone the Apps directory
git clone https://github.com/ignite/apps.git && cd apps
# Scaffold a template for your own app
ignite scaffold app <name> && cd <name>
# Install your app
ignite app install -g $(pwd)
```

### **Contribution Prerequisites**

- Familiarity with Git and GitHub.
- Understanding of the project's technology stack and goals.

## **Community**

- Join the community conversations on [Discord](https://discord.com/invite/ignite) or [X/Twitter](https://twitter.com/ignite).
- Follow the project's progress and updates.

## **Pull Request Process**

- Update the README.md or documentation with details of changes to the interface, if applicable.
- Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent.
- The pull request will be merged once it's reviewed and approved by the maintainers.

## **License**

**TODO**

## **Questions?**

If you have any questions about contributing, please feel free to contact us.

Thank you for your interest in contributing to Ignite Apps!
Loading

0 comments on commit 9a9334e

Please sign in to comment.