mirror of
https://github.com/Zagrios/bs-manager.git
synced 2026-07-03 14:08:25 +02:00
Update CONTRIBUTING.md
This commit is contained in:
GaetanGrd
+92
-22
@@ -1,33 +1,103 @@
|
||||
## Contributing
|
||||
# Contributing to BS-Manager
|
||||
|
||||
[code-of-conduct]: CODE_OF_CONDUCT.md
|
||||
[fork]: https://github.com/Zagrios/bs-manager/fork
|
||||
[pr]: https://github.com/Zagrios/bs-manager/compare
|
||||
[style]: https://github.com/basarat/typescript-book/blob/master/docs/styleguide/styleguide.md
|
||||
[code-of-conduct]: CODE_OF_CONDUCT.md
|
||||
[fork]: https://github.com/Zagrios/bs-manager/fork
|
||||
[pr]: https://github.com/Zagrios/bs-manager/compare
|
||||
|
||||
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
|
||||
Hello! We’re delighted that you’re interested in contributing to **BS-Manager**. Your help is essential to maintaining and improving this project.
|
||||
|
||||
Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
|
||||
> [!NOTE]
|
||||
> This project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating, you agree to abide by its terms.
|
||||
|
||||
## Issues and PRs
|
||||
---
|
||||
|
||||
If you have suggestions for how this project could be improved, or want to report a bug, open an issue! We'd love all and any contributions. If you have questions, too, we'd love to hear them.
|
||||
## Opening Issues
|
||||
|
||||
We'd also love PRs. If you're thinking of a large PR, we advise opening up an issue first to talk about it, though! Look at the links below if you're not sure how to open a PR.
|
||||
- **Reporting Bugs**
|
||||
If you find a bug or any unexpected behavior, feel free to open an issue. Be sure to include steps to reproduce it, relevant logs, versions, and any other pertinent details.
|
||||
- **Suggesting Enhancements**
|
||||
Have an idea for improving BS-Manager? We welcome all suggestions—open an issue to discuss your proposal.
|
||||
|
||||
## Submitting a pull request
|
||||
> [!TIP]
|
||||
> Before opening a new issue, please check if there’s already an existing one for the same topic to avoid duplicates.
|
||||
|
||||
1. [Fork][fork] and clone the repository.
|
||||
1. Install the correct NodeJS version (highly recommend installing [Volta](https://volta.sh/) for that).
|
||||
1. Configure and install the dependencies: `npm install`.
|
||||
1. Create a new branch following naming convention: `git checkout -b (feature|bugfix|hotfix|chore)/(short-description)(/issue-id)`.
|
||||
1. Make your change, test, and make sure BSManager work fine.
|
||||
1. Push to your fork and [submit a pull request][pr].
|
||||
1. Pat your self on the back and wait for your pull request to be reviewed and merged.
|
||||
---
|
||||
|
||||
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
|
||||
## Submitting Pull Requests
|
||||
|
||||
- Follow the [style guide][style] which is using standard.
|
||||
- Keep your changes as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
|
||||
### Before You Begin
|
||||
|
||||
Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocked you.
|
||||
1. **[Fork the repository][fork]** and **clone** your fork locally.
|
||||
2. **Install the required Node.js version** (we recommend using [Volta](https://volta.sh/) to manage Node versions).
|
||||
3. **Install project dependencies**:
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
### Create a Dedicated Branch
|
||||
|
||||
Use a clear naming convention for your branch:
|
||||
|
||||
```bash
|
||||
git checkout -b (feature|bugfix|hotfix|chore)/(short-description)(/issue-id)
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> Exemple : `git checkout -b feature/update-docs/42`
|
||||
|
||||
### Develop and Test
|
||||
|
||||
- Make the necessary changes on your new branch.
|
||||
- Test your changes manually to ensure everything is working correctly.
|
||||
- Verify that your updates do not introduce regressions or break existing functionality.
|
||||
|
||||
### 2.4 Open a Pull Request
|
||||
|
||||
1. **Push** your branch to your fork.
|
||||
2. Visit the main **BS-Manager** repository and click “Compare & pull request” or use [this link][pr].
|
||||
3. Provide a **clear description** of your changes (the context, what problem it solves, etc.).
|
||||
4. **Submit** your pull request. A maintainer will review it and may ask for adjustments or clarifications.
|
||||
|
||||
---
|
||||
|
||||
## 3. Useful Commands
|
||||
|
||||
### Development
|
||||
|
||||
```bash
|
||||
npm start
|
||||
```
|
||||
|
||||
> Runs the application in development mode.
|
||||
|
||||
### Packaging
|
||||
|
||||
```bash
|
||||
npm run package
|
||||
```
|
||||
|
||||
> Packages the application using Electron Builder.
|
||||
|
||||
```bash
|
||||
npm run build && electron-builder --config electron-builder.config.js --publish never --x64 --linux <deb/rpm/pacman>
|
||||
```
|
||||
|
||||
> Package for Linux distros (deb, rpm, pacman)
|
||||
|
||||
```bash
|
||||
npm run publish
|
||||
```
|
||||
|
||||
> Publishes the application (primarily for Windows).
|
||||
|
||||
```bash
|
||||
npm run publish:flatpak
|
||||
```
|
||||
|
||||
> Build a Flatpak package
|
||||
|
||||
## Need Help?
|
||||
|
||||
If you have any questions or need further assistance, feel free to **open an issue** or reach out via the project’s communication channels. We appreciate any and all contributions you make to BS-Manager!
|
||||
|
||||
Thank you for your interest in making BS-Manager better!
|
||||
|
||||
Reference in New Issue
Block a user