Skip to content

Commit

Permalink
doc: CONTRIBUTING (#52)
Browse files Browse the repository at this point in the history
  • Loading branch information
onl1ner authored Mar 29, 2024
1 parent 3fca884 commit 31b5337
Show file tree
Hide file tree
Showing 7 changed files with 132 additions and 1 deletion.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: 🐞 Bug Report
description: File a bug report.
title: "bug: "
labels: ["bug"]
body:
- type: textarea
attributes:
label: Description
placeholder: A concise description of what you're experiencing...
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
placeholder: A concise description of what you expected to happen...
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce
placeholder: Steps to reliably reproduce the behavior...
validations:
required: true
- type: textarea
attributes:
label: Environment
placeholder: |
- macOS:
- mupl:
validations:
required: false
- type: textarea
attributes:
label: Screenshots
placeholder: If relevant, please attach any applicable screenshots or screen recordings...
validations:
required: false
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: ✨ Feature Request
description: Propose an idea for enhancing this project.
title: "feature: "
labels: ["feature"]
body:
- type: textarea
attributes:
label: Description
placeholder: A concise description of an idea...
validations:
required: true
- type: textarea
attributes:
label: Screenshots
placeholder: If relevant, please attach any applicable screenshots or screen recordings...
validations:
required: false
24 changes: 24 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!--- IMPORTANT: Fill out all required fields. Otherwise this PR will be closed temporarily -->

### Description

<!--- REQUIRED: Describe what changed in detail -->

### Related Issues

<!--- REQUIRED: Tag all related issues -->
<!--- INFO: If there are more than one issue, add them to the list while preserving the style. -->

* Closes #ISSUE_NUMBER

### Checklist

<!--- REQUIRED: Every item on the checklist must be checked -->

- [ ] I read and understood the [contributing guide](/CONTRIBUTING.md)
- [ ] The issues this PR addresses are related to each other
- [ ] My code builds and runs on my machine

### Screenshots

<!--- INFO: If the issue is UI-related, this field is REQUIRED. -->
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
## Explore

Every contribution to the project, be it a bug report, feature request, or pull request is essential, because the collective input will drive the project forward. Before contributing to the project it is recommended to first explore the existing issues. This understanding helps to see what is currently being tracked and what priorities the project holds.

Features and bugs can be explored on the [project's boards](https://github.com/orgs/mupl-app/projects/1/views/8). If you find a task you want to work on please indicate it in the issue or attach a draft PR to it once available.

## Issues

If you wish to contribute by identifying bugs or suggesting new features, you could open an issue with the use of specific templates.

When you discover a bug, start by selecting the [bug report](https://github.com/mupl-app/mupl-macos/issues/new?template=bug_report.yml) template. This template will guide you through providing all necessary information about the issue. Although some fields are optional, filling them out can be incredibly helpful.

If you have an idea for a new feature that could enhance the project, use the [feature request](https://github.com/mupl-app/mupl-macos/issues/new?template=feature_request.yml) template to share your suggestion. A clear and concise description is crucial here. Clarity here helps others quickly grasp the value and functionality of your proposed feature. Though including screenshots is optional for feature requests, they can be helpful and can often communicate concepts more effectively than text alone.

## Pull Request

When you are ready to submit your changes to the project, you can open a pull request.

The PR will be automatically filled with the template, which serves as a guide to ensure you provide all the necessary information about your contribution. Please read the template carefully, because it is essential to understand what is expected in your submission.

The template includes the information you must complete:

- **Description**: Offer a clear explanation of what changes you have made and why. This should be concise yet informative.
- **Related Issues**: Link to any issues your pull request addresses. Please note that issues and PR must be related. If your PR addresses several unrelated issues, it is crucial to separate them.
- **Checklist**: This section is your confirmation that you have adhered to all the submission guidelines. Double-check each item to ensure nothing is missed.
- **Screenshots**: If your changes include visual elements or UI updates, screenshots are required. They provide a quick reference for reviewers to assess the visual impact of your changes.
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Tamerlan Satualdypov

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@

- [Motivation](#motivation)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [Download](#download)
- [License](#license)

Expand All @@ -31,7 +32,11 @@ Contrasting sharply with its iOS counterpart, which boasts a sleek design and su

## Roadmap

Upcoming features and issues planned for the next iteration of the application are organized and presented on the [roadmap board](https://github.com/orgs/mupl-app/projects/1/views/8). Contributions are incredibly welcome and appreciated, truly making a difference in the project's direction and growth.
Upcoming features and issues planned for the next iteration of the application are organized and presented on the [roadmap board](https://github.com/orgs/mupl-app/projects/1/views/8). Contributions are incredibly welcomed and appreciated, truly making a difference in the project's direction and growth.

## Contributing

Before making any contribution, it is recommended to review the [contribution guidelines](/CONTRIBUTING.md). Every contribution significantly impacts the project, enhancing its functionality and user experience.

## Download

Expand Down

0 comments on commit 31b5337

Please sign in to comment.