Skip to content

Commit

Permalink
Merge pull request #6 from ARYAN-NIKNEZHAD/docs/docs-package
Browse files Browse the repository at this point in the history
📚  Update docs package
  • Loading branch information
sepehr-akbarzadeh authored Aug 28, 2024
2 parents d162746 + 5c8233b commit b8a7554
Show file tree
Hide file tree
Showing 3 changed files with 182 additions and 4 deletions.
8 changes: 4 additions & 4 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ Thank you for your interest in contributing to our package! This document outlin
5. **Run Code Quality Checks**: Ensure code quality with pre-commit, Ruff, and Pylint.
```bash
pre-commit run --all-files
ruff check django_sage_invoice --fix
black django_sage_invoice/
isort django_sage_invoice/
pylint django_sage_invoice
ruff check sage_invoice --fix
black sage_invoice/
isort sage_invoice/
pylint sage_invoice
```

6. **Run Tests**: Ensure all tests pass using Poetry.
Expand Down
153 changes: 153 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
# Contributing to django-sage-invoice

Thank you for considering contributing to `django-sage-invoice`! We welcome contributions from the community to help make this project better.

## Table of Contents

- [Contributing to django-sage-invoice](#contributing-to-django-sage-invoice)
- [Table of Contents](#table-of-contents)
- [Getting Started](#getting-started)
- [Running Tests](#running-tests)
- [Code Style](#code-style)
- [Security Checks](#security-checks)
- [Pre-commit Hooks](#pre-commit-hooks)
- [Setting Up Pre-commit Hooks](#setting-up-pre-commit-hooks)
- [Submitting a Pull Request](#submitting-a-pull-request)
- [Reporting Issues](#reporting-issues)
- [Additional Resources](#additional-resources)

## Getting Started

1. **Fork the repository on GitHub**:

Go to the [django-sage-invoice](https://github.com/your-username/django-sage-invoice) repository and click on the "Fork" button in the top-right corner.

2. **Clone your fork locally**:

```bash
git clone https://github.com/your-username/django-sage-invoice.git
cd django-sage-invoice
```

3. **Install dependencies using Poetry**:

If you don't have Poetry installed, you can install it by following the instructions on the [Poetry website](https://python-poetry.org/docs/#installation).

```bash
poetry install
```

4. **Create a new branch for your feature or bugfix**:

```bash
git checkout -b feature/your-feature
```

## Running Tests

We use `pytest` for testing. To run the tests, execute:

```bash
poetry run pytest
```

Ensure that all tests pass before submitting a pull request.

## Code Style

We use `black` and `isort` to format our code. Please ensure your code is formatted correctly before submitting a pull request:

```bash
poetry run black .
poetry run isort .
```

Additionally, we use `flake8` and `pylint` for linting. You can run these tools to check for code style issues:

```bash
poetry run flake8
poetry run pylint sage_invoice
```

## Security Checks

We use `bandit` to perform security checks on our codebase. Bandit helps identify common security issues in Python code.

### Running Bandit

To run Bandit with the current configuration:

```bash
poetry run bandit -c pyproject.toml
```


## Pre-commit Hooks

We use `pre-commit` to ensure code quality and consistency. Pre-commit hooks will run automatically before each commit to check and format the code.

### Setting Up Pre-commit Hooks

1. **Install pre-commit**:

```bash
poetry add --dev pre-commit
```

2. **Install the pre-commit hooks**:

```bash
poetry run pre-commit install
```

3. **Run pre-commit hooks manually (optional but recommended before committing)**:

```bash
poetry run pre-commit run --all-files
```

The pre-commit configuration is defined in the `.pre-commit-config.yaml` file. Make sure to review and understand the hooks configured.

## Submitting a Pull Request

1. **Commit your changes**:

Write clear and descriptive commit messages. Follow the guidelines in the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification if possible.

```bash
git commit -am 'feat: add new email feature'
```

2. **Push to the branch**:

```bash
git push origin feature/your-feature
```

3. **Open a pull request on GitHub**:

Go to the original repository on GitHub and open a pull request. Provide a clear and descriptive title and description for your pull request. Link to any relevant issues or discussions.

4. **Wait for review**:

One of the project maintainers will review your pull request. Be responsive to feedback and be prepared to make changes if necessary.

## Reporting Issues

If you find a bug or have a feature request, please open an issue on GitHub. Provide as much detail as possible to help us understand and address the issue:

1. **Go to the [Issues](https://github.com/your-username/django-sage-invoice/issues) section of the repository.**
2. **Click on "New issue".**
3. **Fill out the issue template with relevant details.**

## Additional Resources

- [Poetry Documentation](https://python-poetry.org/docs/)
- [Black Documentation](https://black.readthedocs.io/en/stable/)
- [isort Documentation](https://pycqa.github.io/isort/)
- [pytest Documentation](https://docs.pytest.org/en/stable/)
- [flake8 Documentation](https://flake8.pycqa.org/en/latest/)
- [pylint Documentation](https://pylint.pycqa.org/en/latest/)
- [Pre-commit Documentation](https://pre-commit.com/)

Thank you for contributing!
25 changes: 25 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Contributors

We would like to thank the following people for their contributions to the `django-sage-invoice` project:

## Core Contributors

- **Sepehr Akbarzadeh**
- GitHub: [sageteam](https://github.com/sepehr-akbarzadeh)
- Email: [email protected]
- Contributions: Project creator and lead maintainer.

- **Radin Ghahremani**
- GitHub: [radinceorc](https://github.com/radinceorc)
- Email: [email protected]
- Contributions: maintainer.

- **Aryan Niknezhad**
- GitHub: [ARYAN-NIKNEZHAD](https://github.com/ARYAN-NIKNEZHAD)
- Email: [email protected]
- Contributions: maintainer.
---

To be added to this list, please contribute to the project by submitting a pull request, opening issues, or helping improve the documentation. We appreciate all contributions, big and small!

If you have contributed and are not listed here, please feel free to add your name and details in a pull request.

0 comments on commit b8a7554

Please sign in to comment.