Skip to content

Commit

Permalink
Updated version. Added CONTRIBUTING/CODE OF CONDUCT
Browse files Browse the repository at this point in the history
  • Loading branch information
andresgutierrez committed Jul 25, 2024
1 parent 952c778 commit 972c0a0
Show file tree
Hide file tree
Showing 4 changed files with 173 additions and 3 deletions.
77 changes: 77 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# CODE OF CONDUCT

## Our Pledge

We, as members, contributors, and leaders, pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible 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.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others’ private information, such as a physical or email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.

Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [andres@brainz.co]. All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of actions.

**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).

Community Impact Guidelines were inspired by [Mozilla’s code of conduct enforcement ladder](https://github.com/mozilla/diversity).

For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).
93 changes: 93 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
# CONTRIBUTING.md

Thank you for considering contributing to Nixie! Your contributions help improve and maintain the library for everyone.

## Getting Started

### Fork and Clone the Repository

1. Fork the repository on GitHub.
2. Clone your forked repository to your local machine:
```bash
git clone https://github.com/andresgutierrez/nixie.git
```
3. Navigate to the cloned directory:
```bash
cd nixie
```

### Setting Up Your Development Environment

1. Ensure you have .NET SDK installed. You can download it [here](https://dotnet.microsoft.com/download).
2. Restore dependencies:
```bash
dotnet restore
```
3. Build the project:
```bash
dotnet build
```

### Running Tests

1. Ensure all tests pass before making any changes:
```bash
dotnet test
```

## Making Changes

### Branching

1. Create a new branch for your feature or bug fix:
```bash
git checkout -b feature/your-feature-name
```
or
```bash
git checkout -b bugfix/your-bugfix-name
```

### Coding Standards

- Follow the existing code style and conventions.
- Ensure your code is well-documented with comments where necessary.
- Write tests for new features and bug fixes.

### Commit Messages

- Write clear, concise commit messages.
- Use the present tense ("Add feature" not "Added feature").
- Include a reference to the issue number if applicable (e.g., `Fixes #123`).

### Pushing Changes

1. Push your changes to your fork:
```bash
git push origin feature/your-feature-name
```

2. Open a pull request on the original repository.

## Pull Request Process

1. Ensure your pull request description clearly explains the changes and the reasons for them.
2. Ensure your code passes all tests and adheres to the project's coding standards.
3. Be responsive to feedback and questions. The maintainers may request changes before your pull request can be merged.

## Reporting Issues

1. Check the [existing issues](https://github.com/andresgutierrez/nixie/issues) before opening a new one to avoid duplicates.
2. Open a new issue and provide detailed information about the problem, including steps to reproduce, expected behavior, and actual behavior.
3. If you have a solution, feel free to submit a pull request along with the issue.

## Community and Support

- Join our [discussion forum](https://github.com/andresgutierrez/nixie/discussions) for general questions and support.
- Follow the [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a welcoming and inclusive environment for all contributors.

Thank you for your contributions!

---

By contributing to this project, you agree to abide by the [Code of Conduct](CODE_OF_CONDUCT.md).
2 changes: 1 addition & 1 deletion Nixie/Nixie.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<PackageId>Nixie</PackageId>
<Version>1.0.0</Version>
<Version>1.0.1</Version>
<Description>A Lightweight Actor Model Implementation for C#/.NET</Description>
<Authors>Andres Gutierrez</Authors>
<Company>Andres Gutierrez</Company>
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@ To install Nixie into your C#/.NET project, you can use the .NET CLI or the NuGe
#### Using .NET CLI

```shell
dotnet add package Nixie --version 1.0.0
dotnet add package Nixie --version 1.0.1
```

### Using NuGet Package Manager

Search for Nixie and install it from the NuGet package manager UI, or use the Package Manager Console:

```shell
Install-Package Nixie -Version 1.0.0
Install-Package Nixie -Version 1.0.1
```

## Usage
Expand Down

0 comments on commit 972c0a0

Please sign in to comment.