Skip to content

Commit

Permalink
Add contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
guywaldman committed Jul 16, 2024
1 parent 2734a88 commit 7c4ad16
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 1 deletion.
40 changes: 40 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Contributing to Magic CLI

Thank you for your interest in contributing to Magic CLI!

Please follow this process for contributing code:
1. Open an issue to discuss the changes you want to make
1. Wait for maintainers to approve this change
> This step is solely to reduce noise and avoid redundant work for implementing a change that isn't accepted. The assumption is that that a maintainer will review the issue in reasonable time.
## Contributioon Workflow

1. Fork the respository
1. Implement the change you wish to make
1. Open a pull request that references the relevant issue
1. Make sure that the CI passes
1. Wait for maintainers to review and approve the pull request

## Development Environment

### Prerequisites

1. Rust toolchain and Cargo (MSVC: 1.78.0)

### Workflow

```shell
git clone https://github.com/{your-username}/magic-cli
cd magic-cli

# ...Implement the changes you wish to make

cargo fmt
cargo test

# ...Commit your changes

# ...Push your changes

# ...Open a pull request
```
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,6 @@ Please see [SECURITY.md](SECURITY.md) for more information, and instructions on

Contributions are welcome!

There are not yet official contribution guidelines, so if you have a request or found a bug, feel free to open an issue.
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information.

My only request is that pull requests follow an issue, such that we avoid situations of your hard work not being accepted due to a lack of context or necessity.

0 comments on commit 7c4ad16

Please sign in to comment.