Skip to content

Commit

Permalink
final review
Browse files Browse the repository at this point in the history
  • Loading branch information
aguzmans committed Feb 22, 2024
1 parent 86913dd commit b871ce0
Showing 1 changed file with 15 additions and 18 deletions.
33 changes: 15 additions & 18 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,10 @@ Thank you for considering contributing to Kompare! This guide outlines how you c
# Before Contributing
Before diving into contributions, please take note of the following:

Create an Issue: Before starting work on a new feature, bug fix, or any significant change, create an issue to discuss it with the maintainers and the community. This ensures alignment with project goals and prevents duplication of effort.

Understanding the Project: Familiarize yourself with the project's purpose, functionality, and goals by reading the README and exploring the source code.

Reviewing Existing Issues: Check the existing issues on the project's repository to see if there are any open tasks, bugs, or feature requests that align with your interests or expertise.

Coding Standards: Adhere to the project's coding standards and guidelines. If there are none specified, maintain consistency with the existing codebase.
1. We encourge you to create an Issue: Before starting work on a new feature, bug fix, or any significant change, create an issue to discuss it with the maintainers and the community. This ensures alignment with project goals and prevents duplication of effort, etc.
2. Understanding the Project: Familiarize yourself with the project's purpose, functionality, and goals by reading the README and exploring the source code.
3. Reviewing Existing Issues: Check the existing issues on the project's repository to see if there are any open tasks, bugs, or feature requests that align with your interests or expertise.
4. Coding Standards: Adhere to the project's coding standards and guidelines. If there are none specified, maintain consistency with the existing codebase.

# Getting Started
To contribute to Kompare, follow these steps:
Expand All @@ -21,7 +18,9 @@ Clone the Repository: Clone your forked repository to your local machine.

```
git clone https://github.com/your-username/kompare.git
# Create a Branch: Create a new branch for your contribution. Use a descriptive name that summarizes the purpose of your changes.
```
Create a Branch: Create a new branch for your contribution. Use a descriptive name that summarizes the purpose of your changes.
```
git checkout -b feature/your-feature-name
```

Expand All @@ -33,21 +32,19 @@ Commit Your Changes: Commit your changes with clear and concise commit messages.

```
git commit -m "Add feature: Brief description of your changes"
# Push Changes: Push your commits to your forked repository.
```
Push Changes: Push your commits to your forked repository.
```
git push origin feature/your-feature-name
```
Submit a Pull Request: Once you have pushed your changes to your fork, submit a pull request to the main Kompare repository. Provide a detailed description of your changes and reference the related issue(s) if applicable.

# Main Contribution Areas
Here are the main areas where contributions are particularly welcome:

Adding Test Cases: Help improve test coverage by adding comprehensive test cases for existing and new functionality.

Enhancing Visualization: Improve the visualization and summary view for better user experience and understanding of differences.

Addressing Issues and Bugs: Participate in issue resolution by identifying, reporting, and fixing bugs or addressing existing issues.

Documentation: Enhance project documentation, including README, code comments, and user guides, to make it more accessible and informative.
Here are the main areas where contributions are particularly welcome, but feel free to suggest diferently:
1. Adding Test Cases: Help improve test coverage by adding comprehensive test cases for existing and new functionality.
2. Enhancing Visualization: Improve the visualization and summary view for better user experience and understanding of differences.
3. Addressing Issues and Bugs: Participate in issue resolution by identifying, reporting, and fixing bugs or addressing existing issues.
4. Documentation: Enhance project documentation, including README, code comments, and user guides, to make it more accessible and informative.

# Discussion and Other Issues
If you have ideas, questions, or concerns that are not covered by existing issues, feel free to create new issues to discuss them with the community and the maintainers. Collaboration and open communication are key to driving the project forward.
Expand Down

0 comments on commit b871ce0

Please sign in to comment.