Skip to content

Commit

Permalink
adding the CONTRIBUTING file (#260)
Browse files Browse the repository at this point in the history
  • Loading branch information
superiorsd10 authored Dec 26, 2023
1 parent 22519db commit be80d16
Showing 1 changed file with 71 additions and 0 deletions.
71 changes: 71 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Contributing to Ultimate Alarm Clock

Thank you for considering contributing to the Ultimate Alarm Clock project! Your contributions are valuable and help make the application even better.



## Prerequisites
Before getting started, ensure you have the following prerequisites installed on your system:

- [Flutter](https://flutter.dev/docs/get-started/install): Install the latest version of Flutter, including Dart SDK, by following the official installation guide.

- [Git](https://git-scm.com/downloads): Version control tool to clone the project's repository.

- A code editor such as [Visual Studio Code](https://code.visualstudio.com/) or [Android Studio](https://developer.android.com/studio) with Flutter and Dart plugins.

## How to Contribute

1. **Fork the Repository**: Start by forking the project's repository to your GitHub account.

2. **Clone the Repository**: Clone the forked repository to your local development environment using the following command:

```bash
git clone https://github.com/your-username/ultimate-alarm-clock.git
```

3. **Create a Branch**: Create a new branch for your contributions, giving it a descriptive name.

```bash
git checkout -b your-feature-name
```

4. **Make Changes**: Make your desired changes, improvements, or bug fixes in your local environment.

5. **Test**: Ensure that your changes do not introduce new issues and do not break existing features. Test your code thoroughly.

6. **Documentation**: If your changes impact the user interface, configuration, or functionality, update the documentation to reflect the changes.

7. **Commit**: Commit your changes with a clear and concise message.

```bash
git commit -m "Add feature/fix: Describe your changes here"
```

8. **Push Changes**: Push your changes to your GitHub fork.

```bash
git push origin your-feature-name
```

9. **Pull Request**: Create a Pull Request (PR) from your fork to the original repository. Ensure your PR has a clear title and description outlining the changes.

10. **Code Review**: Your PR will undergo code review. Make any necessary adjustments based on feedback.

11. **Merge**: Once your PR is approved, it will be merged into the main project repository.

## Reporting Issues

If you find a bug or have a suggestion for improvement, please create an [issue](https://github.com/CCExtractor/ultimate_alarm_clock/issues/new) on the project's GitHub repository. Be sure to include a clear and detailed description of the problem or enhancement.
We appreciate your contributions to the Ultimate Alarm Clock project, and your help is invaluable in making it even better.
If you have any questions regarding something in the project, do not hesitate to ask :)
## Guidelines
- Be respectful and considerate when contributing and interacting with the community.
- Follow the project's coding style, conventions, and best practices.
- Keep your PR focused on a single issue or feature. If you wish to contribute multiple changes, create separate branches and PRs for each.
- Provide a detailed and clear description of your PR, including the purpose of the changes and any related issues.
- Ensure that your code is well-documented and that any new features or changes are reflected in the project's documentation.
- Make sure your contributions do not introduce security vulnerabilities or cause regressions.

0 comments on commit be80d16

Please sign in to comment.