Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 : Adding GitHub projects contributing rules #60

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@

# Code of Conduct

## 1. Purpose

A primary goal of immosheets is to be inclusive to the largest number of contributors,
with the most varied and diverse backgrounds possible. As such, we are committed to
Dismissed Show dismissed Hide dismissed
providing a friendly, safe, and welcoming environment for all, regardless of gender,
sexual orientation, ability, ethnicity, socioeconomic status, and religion (or lack thereof).
Dismissed Show dismissed Hide dismissed

## 2. Expected Behavior

* Participate in an authentic and active way.
* Exercise consideration and respect in your speech and actions.
* Attempt collaboration before conflict.
* Refrain from demeaning, discriminatory, or harassing behavior and speech.
* Be mindful of your surroundings and of your fellow participants.

## 3. Unacceptable Behavior

Unacceptable behaviors include: intimidating, harassing, abusive, discriminatory, derogatory or
Dismissed Show dismissed Hide dismissed
demeaning speech or actions by any participant in our community online, at all related events
Dismissed Show dismissed Hide dismissed
and in one-on-one communications carried out in the context of community business. Community
Dismissed Show dismissed Hide dismissed
event venues may be shared with members of the public; please be respectful
to all patrons of these locations.

## 4. Consequences of Unacceptable Behavior

Unacceptable behavior from any community member, including sponsors and those with
decision-making authority, will not be tolerated. Anyone asked to stop unacceptable
behavior is expected to comply immediately. If a community member engages in
unacceptable behavior, the community organizers may take any action they
deem appropriate, up to and including a temporary ban or permanent
expulsion from the community without warning.

## 5. Reporting Guidelines

If you are subject to or witness unacceptable behavior,
or have any other concerns, please notify a community organizer as soon as possible.

## 6. Scope

We expect all community participants (contributors, paid or otherwise; sponsors;
and other guests) to abide by this Code of Conduct in all community venues—online
and in-person—as well as in all one-on-one communications pertaining to community business.
Dismissed Show dismissed Hide dismissed
54 changes: 54 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@

# Contributing to immosheets

Thank you for considering contributing to immosheets! Every contribution,
whether a typo fix or a new feature, is valuable for the project.
This document provides guidelines and steps for contributing.

## Code of Conduct

By participating in this project, you are expected to uphold our [Code of Conduct](CODE_OF_CONDUCT.md).

## How Can I Contribute?

### Reporting Bugs

1. Ensure the bug was not already reported by searching on GitHub
under [Issues](https://github.com/arthuRHD/immosheets/issues).
2. If you're unable to find an open issue addressing the problem,
[open a new one](https://github.com/arthuRHD/immosheets/issues/new).
Include a clear title, detailed description, and as much relevant information as possible.
Dismissed Show dismissed Hide dismissed

### Suggesting Enhancements

1. First, read the documentation to ensure the feature hasn't been discussed or implemented.
2. Propose your new feature in an [issue](https://github.com/arthuRHD/immosheets/issues/new).
Include design mockups or diagrams if applicable.

### Pull Requests

1. Fork the repository and create your branch from `main`.
2. Ensure the test suite passes using `pytest`.
3. Issue that pull request!

## Development Setup

1. Fork and clone the repository.
2. Install the required dependencies using `pip install -r requirements.txt`.
3. Make your changes and test them.
4. Submit your pull request.

## Styleguides

### Git Commit Messages

* Start the commit message with an appropriate [gitmoji](https://gitmoji.dev/).
For example: `🐛: Fix a bug` or `✨: Add new feature`.
* Use the present tense ("Add feature" not "Added feature").
* Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
* Limit the first line to 72 characters or less.
* Reference issues and pull requests liberally after the initial message.

### Python Styleguide

All Python code must adhere to the PEP 8 style guide.
Loading