We appreciate your interest in contributing to Eminence Wallet! Your contributions can help make our open-source wallet software even better. Please read through the following sections to understand how you can contribute to the project.
We love your help! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Submitting a fix
- Proposing new features
- Becoming a contributor
- Bug Reports and Feature Requests
- Pull Requests
- Fork the Repository
- Set Up Your Local Environment
- Create a New Branch
- Make Changes
- Test Your Changes
- Commit and Push
- Submitting a Pull Request
- Pull Request Review
- Merge and Deployment
- License
If you encounter a bug while using Eminence Wallet or have a feature request in mind, please follow these steps:
Before submitting a new issue, please search through the existing issues on our GitHub repository to ensure that the bug or feature request hasn't been reported or requested already. If you find a related issue, you can provide additional information or add a "+1" reaction to indicate your interest in it.
If you couldn't find a related issue, go ahead and submit a new one. To create a new issue, click on the "Issues" tab in the Eminence Wallet repository and select "New Issue". Clearly describe the bug or feature request, providing as much relevant information as possible. Include the following details:
-
Bug Reports:
- Describe the observed behavior and explain why you believe it is a bug.
- Provide steps to reproduce the bug if you can reliably replicate it.
- Include any error messages, stack traces, or logs related to the issue.
- Mention the version of Eminence Wallet and any other relevant software or libraries being used.
-
Feature Requests:
- Clearly describe the desired functionality or feature.
- Explain why you believe it would be valuable for Eminence Wallet.
- Provide any additional context, use cases, or examples that can help the maintainers understand your request.
Engage in the discussion on the issue thread by providing additional information or clarifications if requested by maintainers or other contributors. Feel free to share your thoughts, suggestions, or alternative approaches related to the reported bug or feature request. Your input will help us better understand the issue or feature request.
The maintainers may apply labels to categorize and prioritize the issues. These labels help in organizing and tracking the progress of issues. If you notice any relevant labels missing from an issue, feel free to suggest them or discuss them in the issue thread.
We welcome and encourage contributions through pull requests. If you have a code fix, improvement, or new feature to propose, follow these steps:
Start by forking the Eminence Wallet repository to your GitHub account. This will create a copy of the repository under your account.
Clone the forked repository to your local machine and follow the installation instructions provided in the project's Developer's Guide. This will set up the necessary dependencies and get you ready to work on the project.
- Clone the forked repo
- Install the dependencies
- Run the project
Create a new branch for your contribution. Use a descriptive branch name that reflects the nature of your work.
# Create a new branch
$ git branch <branch-name>
# Switch to the newly created branch
$ git checkout <branch-name>
Note: Replace with a descriptive name for your branch.
After running these commands, you will have created a new branch with a name of your choice and switched to that branch. You can then make your changes and commit them to this branch.
Implement your changes or additions in the appropriate files within the project. Ensure that your code follows the existing coding style and conventions Developer's Guide.
Thoroughly test your changes to ensure they work as intended and do not introduce any new issues.Commit your changes with clear and concise commit messages. Push the changes to your forked repository.
# Add the changes to the staging area
$ git add .
# Commit the changes with a descriptive message
$ git commit -m "Your commit message"
# Push the changes to the remote repository
$ git push origin <branch-name>
After running these commands, your changes will be committed with the specified message and pushed to the remote repository in the specified branch.
Go to the original Eminence Wallet repository and locate the "Pull Requests" tab. Click on "New Pull Request" and provide a clear title and description for your pull request. Reference any related issues if applicable. Include the following points in your pull request:
- Describe the purpose and scope of your changes.
- Explain the problem you're addressing or the feature you're adding.
- Provide a high-level overview of the changes made.
- Include any relevant code snippets, if applicable, to showcase the specific changes made.
Your pull request will undergo review by the project maintainers. Be responsive to feedback and address any requested changes promptly. Discuss and collaborate with the maintainers to ensure the quality and coherence of your contribution.
Note: After a pull request has been open for over 30 days with no activity or response from the author, it'll be automatically marked as stale. We might fork your changes and merge the changes ourselves. Since GitHub tracks contributions by commits, you will be credited.
Once your pull request has been approved, it will be merged into the main branch. The changes will be incorporated into future releases of Eminence Wallet.
Thank you for your contributions to Eminence Wallet! We value your time and effort in helping us improve our open-source resume builder software. Together, we can make Eminence Wallet a more powerful and user-friendly tool for creating outstanding resumes.
If you have any further questions, feel free to reach out to us through the issue tracker or other communication channels provided in the project's README file.
Happy contributing! 💖
By contributing, you agree that your contributions will be licensed under its MIT License.