|
| 1 | +# Contribution Guidelines |
| 2 | + |
| 3 | +Thank you for considering contributing to the Bash Prompt Generator. |
| 4 | +This document will help you with the first steps. |
| 5 | +If anything is unclear, feel free to ask for help or clarification via an [issue](https://github.com/Scriptim/bash-prompt-generator/issues/new?template=question.yml "Ask a question"). |
| 6 | + |
| 7 | +## Reporting a Bug or Requesting a Feature |
| 8 | + |
| 9 | +If you found a bug or have an idea for a new feature, please open an [issue](https://github.com/Scriptim/bash-prompt-generator/issues/new "Open a new issue"). |
| 10 | +The issue templates will guide you through the process. |
| 11 | +Please always confirm that the issue you are about to open does not already exist. |
| 12 | + |
| 13 | +## Contributing Code |
| 14 | + |
| 15 | +Before you start working on the code, please open an [issue](https://github.com/Scriptim/bash-prompt-generator/issues/new "Open a new issue") to discuss the bug or feature you want to work on. |
| 16 | +This way, you can ensure that your contribution is in line with the project's goals and that you are not working on something that is already in progress. |
| 17 | +Otherwise, your pull request might be rejected, and I do not want you to waste your time. |
| 18 | +For very minor changes, e.g., fixing a typo, you can skip this step. |
| 19 | + |
| 20 | +When you are ready to contribute, fork the repository, create a branch for your changes, and open a pull request. |
| 21 | +If you are not familiar with these steps, refer to this [guide](https://opensource.guide/how-to-contribute/#opening-a-pull-request "How to Contribute to Open Source"). |
| 22 | +Feel free to open a draft pull request if you need help or feedback early on. |
| 23 | +Before finalizing your pull request, make sure to follow the instructions in the pull request template. |
| 24 | + |
| 25 | +### Setup Development Environment |
| 26 | + |
| 27 | +To set up your development environment, you need to have [Node.js](https://nodejs.org/ "Node.js") installed. |
| 28 | +After cloning your fork, navigate to the project directory and run `npm install` to install the required dependencies. |
| 29 | +You can the run `npm run serve` to start the development server which make the Bash Prompt Generator available locally. |
| 30 | +Any changes you make to the source code should immediately be reflected in the browser. |
| 31 | +Before committing your changes, run `npm run lint` to verify the code style. |
| 32 | + |
| 33 | +### Commit Messages |
| 34 | + |
| 35 | +The subject line of your commit message should be capitalized, not exceed 50 characters, not end in punctuation and be written in the imperative mood. |
| 36 | +Feel free to include a body to provide more context or explain the reasoning behind your changes. |
| 37 | + |
| 38 | +### Code Review |
| 39 | + |
| 40 | +All contributions will be reviewed before they are merged. |
| 41 | +Please be patient since this process might take some time. |
| 42 | +The project is currently maintained by a single person, and there is no fixed schedule for reviewing pull requests. |
0 commit comments