https://github.com/esther-poniatowski/projecttemplate
https://github.com/esther-poniatowski/projecttemplate
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/esther-poniatowski/projecttemplate
- Owner: esther-poniatowski
- License: gpl-3.0
- Created: 2024-12-05T18:47:14.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-12-17T14:10:30.000Z (6 months ago)
- Last Synced: 2025-01-31T09:17:22.138Z (4 months ago)
- Language: Python
- Size: 3.16 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ProjectTemplate
- [Description](#description)
- [Authors](#authors)
- [Acknowledgments](#acknowledgments)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
## Description
...
## Authors
**First-Name Last-Name** | @github_handle | [email protected]
## Acknowledgments
...
## Installation
> [!TIP]
> To set up this project on a local machine, follow the steps below:
### Initialize a local copy of the repository
1. Navigate to the local directory where the root folder of the repository should reside.
2. Copy the URL of the project in the "Code" section of the main page.
Format: ```[email protected]:/.git```
3. Clone the repository:
```
git clone
```
### Create a virtual environment
1. Create an dedicated conda environment containing all the dependencies:
```
conda env create -f environment.yml
```
2. Register the package in "editable mode":
```
conda activate
pip install -e /src/
```
## Usage
...
## Contributing
> [!IMPORTANT]
> To contribute effectively, please conform to those guidelines and use the provided templates.
### Sumbitting Issues
To submit a new issue:
1. In the repository page, navigate to the "Issues" tab and click on "New Issue".
2. Select and fill the issue template.
3. Add relevant labels, assignees, and milestone if applicable.
### Using the Commit Message Template
1. Navigate inside the repository directory:
```
cd
```
2. Edit the commit template (`.gitmessage`) to specify the author name.
3. Configure `git` to use this file as a commite template:
```
git config commit.template .gitmessage
```
4. Verify the configuration:
```
git config --get commit.template
```
> [!NOTE]
> To write a commit message with this template, adhere to the following format:
>
> - Capitalize the subject, do not add a period at the end
> - Limit the subject line to 50 characters
> - Use the imperative mood in the subject line
> - Separate subject from body with a blank line
> - Wrap the body at 72 characters per line
> - Use the body to explain what and why (not how)
> - Add references to issues or other commits using [GitHub keywords](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests)