Contributing to whoiam
Thank you for your interest in contributing to whoiam! We welcome contributions from the community. Please take a moment to review this document before submitting your contributions.
How to Contribute
-
Fork the repository: Click the "Fork" button at the top right corner of the repository page to create a copy of the repository in your GitHub account.
-
Clone your fork: Clone your forked repository to your local machine using the following command:
sh git clone https://github.com/<your-username>/whoiam.git -
Create a new branch: Create a new branch for your changes to keep your work organized and separate from the main branch.
sh git checkout -b my-feature-branch -
Make your changes: Make the necessary changes to the codebase. Ensure that your code follows the project's coding standards and conventions.
-
Test your changes: Run the tests to ensure that your changes do not break any existing functionality. Add new tests if necessary.
sh go test ./... -
Commit your changes: Commit your changes with a descriptive commit message.
sh git add . git commit -m "Add feature X" -
Push your changes: Push your changes to your forked repository.
sh git push origin my-feature-branch -
Create a pull request: Go to the original repository and create a pull request from your forked repository. Provide a clear and descriptive title and description for your pull request.
Code of Conduct
Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.
Reporting Issues
If you encounter any issues or have any questions, please open an issue on the GitHub Issues page.
License
By contributing to whoiam, you agree that your contributions will be licensed under the Apache License, Version 2.0.
Contact
If you have any questions or need further assistance, feel free to contact the project maintainer at jesse@pytoolbelt.com.
Thank you for your contributions!