We're thrilled about your interest in contributing to Mailer_Frontend! This document outlines the guidelines for making contributions to the project.
There are various ways you can contribute to Mailer_Frontend. Here are some avenues through which you can lend a hand:
- Reporting Bugs: If you come across a bug, please create an issue in our issue tracker.
- Suggesting Enhancements: Have ideas on how to make Mailer_Frontend better? Open an issue with your suggestion.
- Code Contributions: If you want to write code for Mailer_Frontend, that's great! Start by looking at our open issues.
-
Fork the Repository: Start by forking the Mailer_Frontend repository to your GitHub account.
-
Clone the Forked Repository: Clone your fork to your local machine (
git clone <forked-repo-url> <project-name>
). -
Create a New Branch: Create a branch for your contribution (
git checkout -b feature/YourFeature
). -
Make Your Changes: Work on the changes you wish to make.
-
Test Your Changes: Ensure your changes do not introduce any new bugs or issues.
-
Commit Your Changes: Commit your changes with a clear commit message (
git commit -m 'Add YourFeature'
). -
Push to Your Branch: Push your changes to your branch (
git push origin feature/YourFeature
). -
Open a Pull Request: Go to the Mailer_Frontend forked repository and open a pull request from your branch.
Note: Before commit any changes to your code, it's better to pull any recent changes from original repo. Steps to follow
- Add remote url for original repo. (
git remote add upstream <original-mailer-frontend-repo>
). - Pull the changes to your branch. (
git pull upstream <feature/branch>
).
- Ensure your code adheres to the project's coding standards.
- Write clean, readable, and maintainable code.
- Include comments in your code where necessary.
- Keep pull requests concise and focused on a single issue or feature.
- Provide a detailed description of your changes in the pull request.
- Reference any relevant issue numbers in your pull request description.
If you are adding new features or making changes that require documentation updates, please include them in your pull requests.
If you have any questions or need assistance, feel free to open an issue for discussion.
Thank you for contributing to Mailer_Frontend, and we look forward to your contributions!