https://github.com/osantana/development-guidelines

Guidelines for Software Development Projects
https://github.com/osantana/development-guidelines

api documentation guidelines process software-engineering

Last synced: 23 days ago
JSON representation

Guidelines for Software Development Projects

• Host: GitHub
• URL: https://github.com/osantana/development-guidelines
• Owner: osantana
• License: cc0-1.0
• Created: 2021-08-31T17:33:38.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-09T21:11:41.000Z (7 months ago)
• Last Synced: 2024-12-28T11:41:52.445Z (25 days ago)
• Topics: api, documentation, guidelines, process, software-engineering
• Language: Python
• Homepage: https://development-guidelines.readthedocs.io/
• Size: 12.7 MB
• Stars: 20
• Watchers: 5
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Development Guideline

Guidelines for Software Development Projects

## Setup

```

$ python -m venv .venv

$ .venv/bin/pip install -r requirements.txt

```

## Build

Sphinx can generate different formats. To see a list of options:

```

$ make

```

Then run:

```

$ make [format]

```

## History

This document is a mix of different documents that I created at companies where

I used to work.

This document is incomplete, with parts in Brazilian Portuguese, and lots of

'TODOs'.