Skip to content

Commit

Permalink
Prepare for public release (#7)
Browse files Browse the repository at this point in the history
* Update readme

* Update readme and logo

* Update tribe name color

* Update readme with images and remove unused images

* Update yaml files to reference tribe instead
  • Loading branch information
StreetLamb authored May 1, 2024
1 parent 64f4564 commit 42e17ac
Show file tree
Hide file tree
Showing 35 changed files with 269 additions and 386 deletions.
6 changes: 3 additions & 3 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ DOMAIN=localhost
# Environment: local, staging, production
ENVIRONMENT=local

PROJECT_NAME="Full Stack FastAPI Project"
STACK_NAME=full-stack-fastapi-project
PROJECT_NAME="Tribe"
STACK_NAME=tribe

# Backend
BACKEND_CORS_ORIGINS="http://localhost,http://localhost:5173,https://localhost,https://localhost:5173,http://localhost.tiangolo.com"
BACKEND_CORS_ORIGINS="http://localhost,http://localhost:5173,https://localhost,https://localhost:5173,http://localhost.tribe.com"
SECRET_KEY=changethis
FIRST_SUPERUSER=[email protected]
FIRST_SUPERUSER_PASSWORD=changethis
Expand Down
2 changes: 1 addition & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
github: [tiangolo]
github: [StreetLamb]
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
blank_issues_enabled: false
contact_links:
- name: Security Contact
about: Please report security vulnerabilities to security@tiangolo.com
about: Please report security vulnerabilities to security@wovenblocks.com
- name: Question or Problem
about: Ask a question or ask about a problem in GitHub Discussions.
url: https://github.com/tiangolo/full-stack-fastapi-template/discussions/categories/questions
url: https://github.com/StreetLamb/tribe/discussions/categories/q-a
- name: Feature Request
about: To suggest an idea or ask about a feature, please start with a question saying what you would like to achieve. There might be a way to do it already.
url: https://github.com/tiangolo/full-stack-fastapi-template/discussions/categories/questions
url: https://github.com/StreetLamb/tribe/discussions/categories/ideas
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/privileged.yml
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
name: Privileged
description: You are @tiangolo or he asked you directly to create an issue here. If not, check the other options. 👇
description: You are @StreetLamb or he asked you directly to create an issue here. If not, check the other options. 👇
body:
- type: markdown
attributes:
value: |
Thanks for your interest in this project! 🚀
If you are not @tiangolo or he didn't ask you directly to create an issue here, please start the conversation in a [Question in GitHub Discussions](https://github.com/tiangolo/full-stack-fastapi-template/discussions/categories/questions) instead.
If you are not @StreetLamb or he didn't ask you directly to create an issue here, please start the conversation in a [Q&A in GitHub Discussions](https://github.com/StreetLamb/tribe/discussions/categories/q-a) instead.
- type: checkboxes
id: privileged
attributes:
label: Privileged issue
description: Confirm that you are allowed to create an issue here.
options:
- label: I'm @tiangolo or he asked me directly to create an issue here.
- label: I'm @StreetLamb or he asked me directly to create an issue here.
required: true
- type: textarea
id: content
Expand Down
48 changes: 48 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Tribe Code of Conduct

## Our Pledge

We, the community of contributors and users of Tribe, pledge to create a welcoming and inclusive environment for everyone. We are committed to fostering a respectful and harassment-free space where diverse ideas and perspectives can thrive.

## Expected Behavior

To contribute to a positive and inclusive atmosphere, we expect all participants, including contributors, users, and maintainers, to:

1. Be respectful and considerate: Treat others with kindness, respect, and empathy. Recognize and embrace diversity in backgrounds, experiences, and opinions.

2. Be inclusive: Welcome and support people of all backgrounds, identities, and abilities. Avoid any form of discrimination or exclusionary behavior.

3. Listen actively: Pay attention to others' ideas, experiences, and feedback. Be open to constructive criticism and different points of view.

4. Show empathy: Understand that people may have different cultural norms, communication styles, and perspectives. Be patient and considerate when engaging with others.

5. Resolve conflicts constructively: Disagreements and conflicts are natural, but we encourage participants to address them in a respectful and solution-oriented manner. Avoid personal attacks and name-calling.

6. Use clear and inclusive language: Use language that is respectful, inclusive, and considerate of all participants. Avoid offensive, derogatory, or discriminatory language.

## Unacceptable Behavior

The following behaviors are considered unacceptable and will not be tolerated within the Tribe community:

1. Harassment: Any form of harassment, including but not limited to offensive comments, slurs, intimidation, or unwelcome advances, is strictly prohibited.

2. Discrimination: Discriminatory actions or comments based on race, ethnicity, nationality, gender, gender identity, sexual orientation, disability, religion, age, or any other characteristic will not be tolerated.

3. Hate speech: Hate speech, promoting violence, or advocating harm towards individuals or groups based on their identity is not allowed.

4. Personal attacks: Engaging in personal attacks, insults, or trolling of others within the community is unacceptable.

5. Disruptive behavior: Deliberate disruption of discussions, events, or community activities is discouraged.

## Reporting Violations

If you witness or experience behavior that violates this code of conduct, please report it promptly to the project maintainers by contacting [[email protected]]([email protected]).
All reports will be treated with confidentiality, and the project maintainers will take appropriate action as necessary to address violations. We are committed to providing a safe and welcoming environment for all participants.

## Enforcement

Enforcement of this code of conduct will be carried out in a fair and just manner. Depending on the severity and frequency of violations, consequences may include warnings, temporary or permanent bans from the community, or other appropriate actions.

## Attribution

This code of conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
92 changes: 92 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# Tribe Contributing Guide

Thank you for considering contributing to Tribe! We welcome contributions from the community to help improve and enhance our application. Whether you're a developer or just an enthusiast, there are various ways you can get involved and make a meaningful impact.

Before you begin, please take a moment to review this guide, which outlines the contribution process, code of conduct, and how to get help if needed.

## Table of Contents

- [Tribe Contributing Guide](#tribe-contributing-guide)
- [Table of Contents](#table-of-contents)
- [Getting Started](#getting-started)
- [Contributing to Tribe](#contributing-to-tribe)
- [Reporting Bugs](#reporting-bugs)
- [Suggesting Enhancements](#suggesting-enhancements)
- [Code Contribution](#code-contribution)
- [Development Setup](#development-setup)
- [Code of Conduct](#code-of-conduct)
- [Get Help](#get-help)

## Getting Started

Before you start contributing, please ensure you have the following:

- A GitHub account: If you don't have one, you can [create an account here](https://github.com/join).
- Familiarity with Git: You'll need to know the basics of Git for version control.

## Contributing to Tribe

There are several ways you can contribute to Tribe:

### Reporting Bugs

If you encounter any issues, bugs, or unexpected behavior while using Tribe, please help us by [reporting them](https://github.com/StreetLamb/tribe/issues). To report a bug:

1. Check if the issue has already been reported by searching the [GitHub Issues](#) page.
2. If not, create a new issue with a descriptive title and detailed description of the problem you encountered.
3. Include relevant information such as your operating system, Python version, and any error messages.

### Suggesting Enhancements

We appreciate your suggestions for improving Tribe. If you have an idea for an enhancement or new feature, follow these steps:

1. Check if your suggestion has already been proposed in the [GitHub Issues](https://github.com/StreetLamb/tribe/issues) section.
2. If not, create a new issue with a clear and concise title and a detailed description of your suggestion.
3. Include any relevant context or examples to illustrate the enhancement's value.

### Code Contribution

If you're interested in contributing code to Tribe, you can do so by following these steps:

1. Fork the [Tribe repository](https://github.com/StreetLamb/tribe) to your GitHub account.
2. Clone your forked repository to your local machine:

```shell
git clone https://github.com/your-username/tribe.git
```

3. Create a new branch for your contribution:

```shell
git checkout -b feature/your-feature-name
```

4. Make your changes and commit them with clear and concise commit messages.

5. Push your changes to your forked repository:

```shell
git push origin feature/your-feature-name
```

6. Create a pull request (PR) from your branch to the main Tribe repository.

7. Ensure your PR includes a detailed description of the changes, why they are necessary, and any relevant testing or documentation updates.

8. Participate in the review process, addressing any feedback or requested changes.

9. Once your PR is approved, it will be merged into the main repository.

## Development Setup

If you want to contribute code, you'll need to set up a development environment for Tribe. Refer to the [Development Setup](./development.md) guide in the repository for detailed instructions on getting started.
## Code of Conduct
Please review and adhere to our [Code of Conduct](./CODE_OF_CONDUCT.md). We expect all contributors and community members to treat each other with respect and kindness.
## Get Help
If you have questions, need assistance, or want to discuss contributions further, open an issue for discussion.
We appreciate your interest in contributing to Tribe, and we look forward to collaborating with you!
Loading

0 comments on commit 42e17ac

Please sign in to comment.