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

Create CONTRIBUTING.md #21

Merged
merged 1 commit into from
Oct 30, 2022
Merged
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
43 changes: 43 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Contributing

All contributions are welcomed, thank you for taking the time to contribute to this project!

## How can you contribute?

* Report bugs
* Suggest features and ideas
* Pull requests with a solved GitHub issue and new feature
* Pull request with a new content.

## Persistent Git Branches

The following git branches permanent in the Slips repository:

- `main`: contains the stable version of the repository.
- `develop`: all new features should be based on this branch.

## Naming Git branches for Pull Requests

To keep the Git history clean and facilitate the revision of contributions we
ask all branches to follow concise namings. These are the branch-naming patterns
to follow when contributing:

- bugfix-<>: pull request branch, contains one bugfix,
- docs-<>: pull request branch, contains documentation work,
- feat-<>: pull request branch, contains a new feature,
- refactor-<>: pull request branch, contains code refactoring,

## What branch should you base your contribution?

As a general rule, base your contribution on the `develop` branch.

## Creating a pull request

Commits:
- Commits should do one thing. Keep it simple.
- Commit messages should be easily readable, imperative style ("Fix memory leak in...", not "FixES mem...")

Pull Requests:
- If you have developed multiple features and/or bugfixes, create separate
branches for each one of them, and request merges for each branch;
- The cleaner you code/change/changeset is, the faster it will be merged.