Skip to content

Commit

Permalink
Lifelog 1.0.0 : Added CONTRIBUTING.md + README images
Browse files Browse the repository at this point in the history
  • Loading branch information
MrBeam89 committed Sep 15, 2024
1 parent 695b99b commit 1066bcc
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
## Contributing

We welcome contributions from the community! To ensure smooth collaboration, please follow the guidelines below when submitting your changes:

1. **Fork the repository**: Start by forking this repository to your own GitHub account.

2. **Clone your fork**: Clone your forked repository to your local machine.

```bash
git clone https://github.com/YOUR-USERNAME/REPO-NAME.git

3. **Create a new branch**: Always create a new branch for your work, branching off the `dev` branch.
```bash
git checkout dev
git checkout -b feature/your-feature-name
```

4. **Make your changes**: Implement your feature, fix bugs, or make improvements. Be sure to write clean, well-documented code.

5. **Commit your changes**: Write clear and concise commit messages.
```bash
git add .
git commit -m "Add brief description of your feature or fix"
```

6. **Push to your fork**: Push your changes to your forked repository on GitHub.
```bash
git push origin feature/your-feature-name
```

7. **Submit a pull request (PR)**: Once your changes are ready, open a pull request (PR) from your feature branch to the `dev` branch of this repository. Please make sure you **do not submit PRs to the `main` branch**.

- Include a clear description of your changes in the PR.
- Reference any relevant issues or tickets.

### Important Guidelines

- **All pull requests should be made to the `dev` branch**. Contributions submitted to other branches will not be accepted.

- Ensure your code follows the existing style and conventions used in the project.

- Run tests (if applicable) to ensure your changes don’t break existing functionality.

Thank you for contributing! We appreciate your help in making this project better.
Binary file added docs/images/icon_128.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/screenshot_main_lorem.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1066bcc

Please sign in to comment.