|
| 1 | +# Contributing to [LocalStack.NET AWS CLI](https://github.com/localstack-dotnet/localstack-awscli-local) |
| 2 | + |
| 3 | +All kind of pull requests even for things like typos, documentation, test cases, etc are always welcome. By submitting a pull request for this project, you agree to license your contribution under the MIT license to this project. |
| 4 | + |
| 5 | +Please read these guidelines before contributing to LocalStack.NET AWS CLI: |
| 6 | + |
| 7 | + - [Question or Problem?](#question) |
| 8 | + - [Issues and Bugs](#issue) |
| 9 | + - [Feature Requests](#feature) |
| 10 | + - [Submitting a Pull Request](#submit-pull-request) |
| 11 | + - [Getting Started](#getting-started) |
| 12 | + - [Pull Requests](#pull-requests) |
| 13 | + |
| 14 | +## <a name="question"></a> Got a Question or Problem? |
| 15 | + |
| 16 | +If you have questions about how to use LocalStack.NET AWS CLI, you can ask by submitting an issue to the [GitHub Repository][github] |
| 17 | + |
| 18 | +## <a name="issue"></a> Found an Issue? |
| 19 | + |
| 20 | +If you find a bug in the source code or a mistake in the documentation, you can help by |
| 21 | +submitting an issue to the [GitHub Repository][github]. Even better you can submit a Pull Request |
| 22 | +with a fix. |
| 23 | + |
| 24 | +When submitting an issue please include the following information: |
| 25 | + |
| 26 | +- A description of the issue |
| 27 | +- The exception message and stacktrace if an error was thrown |
| 28 | +- If possible, please include code that reproduces the issue. [DropBox][dropbox] or GitHub's |
| 29 | +[Gist][gist] can be used to share large code samples, or you could |
| 30 | +[submit a pull request](#pullrequest) with the issue reproduced in a new test. |
| 31 | + |
| 32 | +The more information you include about the issue, the more likely it is to be fixed! |
| 33 | + |
| 34 | + |
| 35 | +## <a name="feature"></a> Want a Feature? |
| 36 | + |
| 37 | +You can request a new feature by submitting an issue to the [GitHub Repository][github] |
| 38 | + |
| 39 | +## <a name="submit-pull-request"></a> Submitting a Pull Request |
| 40 | + |
| 41 | +Good pull requests, patches, improvements and new features are a fantastic |
| 42 | +help. They should remain focused in scope and avoid containing unrelatedcahe |
| 43 | +commits. When submitting a pull request to the [GitHub Repository][github] make sure to do the following: |
| 44 | + |
| 45 | +- Check that new and updated code follows LocalStack.NET AWS CLI's existing code formatting and naming standard |
| 46 | +- Run LocalStack.NET AWS CLI's unit tests to ensure no existing functionality has been affected |
| 47 | +- Write new unit tests to test your changes. All features and fixed bugs must have tests to verify |
| 48 | +they work |
| 49 | + |
| 50 | +Read [GitHub Help][pullrequesthelp] for more details about creating pull requests. |
| 51 | + |
| 52 | +### <a name="getting-started"></a> Getting Started |
| 53 | + |
| 54 | +- Make sure you have a [GitHub account](https://github.com/signup/free) |
| 55 | +- Submit a ticket for your issue, assuming one does not already exist. |
| 56 | + - Clearly describe the issue including steps to reproduce the bug. |
| 57 | +- Fork the repository on GitHub |
| 58 | + |
| 59 | +### <a name="pull-requests"></a> Pull requests |
| 60 | + |
| 61 | +Adhering to the following process is the best way to get your work |
| 62 | +included in the project: |
| 63 | + |
| 64 | +1. [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork, |
| 65 | + and configure the remotes: |
| 66 | + |
| 67 | + ```bash |
| 68 | + # Clone your fork of the repo into the current directory |
| 69 | + git clone git@github.com:<user-name>/localstack-awscli-local.git |
| 70 | + # Navigate to the newly cloned directory |
| 71 | + cd <folder-name> |
| 72 | + # Assign the original repo to a remote called "upstream" |
| 73 | + git remote add upstream git@github.com:localstack-dotnet/localstack-awscli-local.git |
| 74 | + ``` |
| 75 | + |
| 76 | +2. If you cloned a while ago, get the latest changes from upstream: |
| 77 | + |
| 78 | + ```bash |
| 79 | + git checkout master |
| 80 | + git pull upstream master |
| 81 | + ``` |
| 82 | + |
| 83 | +3. Create a new topic branch (off the main project development branch) to |
| 84 | + contain your feature, change, or fix: |
| 85 | + |
| 86 | + ```bash |
| 87 | + git checkout -b <topic-branch-name> |
| 88 | + ``` |
| 89 | + |
| 90 | +4. Commit your changes in logical chunks. Use Git's |
| 91 | + [interactive rebase](https://help.github.com/articles/interactive-rebase) |
| 92 | + feature to tidy up your commits before making them public. |
| 93 | + |
| 94 | +5. Locally merge (or rebase) the upstream development branch into your topic branch: |
| 95 | + |
| 96 | + ```bash |
| 97 | + git pull [--rebase] upstream master |
| 98 | + ``` |
| 99 | + |
| 100 | +6. Push your topic branch up to your fork: |
| 101 | + |
| 102 | + ```bash |
| 103 | + git push origin <topic-branch-name> |
| 104 | + ``` |
| 105 | + |
| 106 | +7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) |
| 107 | + with a clear title and description against the `master` branch. |
| 108 | + |
| 109 | + |
| 110 | +[github]: https://github.com/localstack-dotnet/localstack-awscli-local |
| 111 | +[dropbox]: https://www.dropbox.com |
| 112 | +[gist]: https://gist.github.com |
| 113 | +[pullrequesthelp]: https://help.github.com/articles/using-pull-requests |
0 commit comments