Skip to content

Latest commit

 

History

History
74 lines (42 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

74 lines (42 loc) · 2.57 KB

Contributing Guidelines

Thank you for considering contributing to the Beginner CLI project! We welcome contributions from everyone, whether it's reporting issues, submitting feature requests, or making code contributions.

How to Contribute

Reporting Issues

If you encounter any issues or bugs, please check the existing issues to see if it has already been reported. If not, feel free to open a new issue with a clear description of the problem, including steps to reproduce if possible.

Feature Requests

Have an idea for a new feature or improvement? You can submit a feature request by opening a new issue and providing a detailed description of the proposed feature, including its use case and any relevant information.

Making Code Contributions

1. Fork the Repository

Start by forking the repository to your GitHub account. This will create a copy of the project in your account that you can freely modify.

2. Clone the Repository

Clone your forked repository to your local machine using the following command:

git clone https://github.com/your-username/Beginner-Cli.git

Replace your-username with your GitHub username.

3. Create a Branch

Create a new branch for your contribution:

git checkout -b feature/my-feature

Replace my-feature with a descriptive name for your feature or bug fix.

4. Make Changes

Make your desired changes to the codebase. Ensure that your changes adhere to the project's coding style and conventions.

5. Test Your Changes

Before submitting a pull request, make sure to test your changes thoroughly. Ensure that your changes do not introduce any new issues and that existing functionality remains intact.

6. Commit Your Changes

Once you're satisfied with your changes, commit them to your branch:

git add .
git commit -m "Add new feature"

Replace "Add new feature" with a descriptive commit message that summarizes the changes you've made.

7. Push Changes

Push your changes to your forked repository:

git push origin feature/my-feature

8. Submit a Pull Request

Finally, submit a pull request by navigating to the original repository and clicking on the "New Pull Request" button. Provide a detailed description of your changes in the pull request, and our team will review it as soon as possible.

Code of Conduct

Please note that by contributing to this project, you agree to abide by the project's Code of Conduct. Please be respectful and considerate towards other contributors and maintain a positive and inclusive environment.