Skip to content

Latest commit

 

History

History
118 lines (80 loc) · 5.83 KB

CONTRIBUTING.md

File metadata and controls

118 lines (80 loc) · 5.83 KB
Raw

Contributing to dyPixa

Thank you for your interest in contributing to dyPixa! By contributing to this open-source project, you help make it better and support its growth. We appreciate your efforts and welcome contributions from the community.

Before you start contributing, please read and follow these guidelines.

  1. Code of Conduct
  2. Types of Contributions
    1. Minor Contributions
    2. Major Contributions
  3. How to Contribute
  4. Reporting Issues
  5. Development Guidelines
  6. Licensing

Code of Conduct

Please note that we have a Code of Conduct (here) in place to ensure a positive and inclusive environment for everyone. By participating in this project, you agree to abide by the Code of Conduct. Unacceptable behavior will not be tolerated.

Types of Contributions

This repository welcomes both minor and major contributions. All valid contributions will be acknowledged and showcased within the repository. Additionally, innovative and research-oriented changes to the project may be considered for publication in reputable venues, with all rights belonging to the original contributors/authors. Detailed descriptions of both minor and major contributions are provided below.

Minor Contributions

Minor contributions are valuable improvements that enhance the project but typically involve non-technical changes or small code modifications. These contributions are essential for improving the overall project quality and include:

  • Documentation: Improving documentation, adding examples, correcting typos, or clarifying instructions.
  • Bug Fixes: Identifying and fixing small bugs or issues that do not require extensive code changes.
  • Enhancements: Implementing minor feature enhancements or optimizations.
  • Code Cleanup: Refactoring code for better readability or maintainability.
  • Testing: Expanding test coverage or fixing small issues in existing tests.
  • Non-Technical Fixes: Addressing non-technical aspects, such as improving project organization, enhancing README content, or updating project metadata.

Contributors are encouraged to make minor contributions, as they help maintain the project's health and improve the user experience.

Major Contributions

Major contributions involve significant code changes, new features, or substantial project improvements. These contributions typically require more effort and discussion with project maintainers. Major contributions include:

  • New Features: Implementing entirely new project features or capabilities.
  • Large-Scale Changes: Making substantial code refactorings or architectural modifications.
  • Complex Bug Fixes: Addressing critical or complex issues that require in-depth code analysis and changes.
  • Performance Enhancements: Enhancing the project's performance through optimization.
  • Integration with External Tools or Services: Integrating dyPixa with external APIs, libraries, or services.

While major contributions are essential for advancing the project, contributors are encouraged to engage with the project maintainers early in the process to discuss design, implementation, and ensure alignment with project goals.

Contributors can choose to make minor or major contributions based on their expertise, availability, and interest in the project. Both types of contributions are highly appreciated and contribute to the overall success of dyPixa.

How to Contribute

Here's how you can contribute to dyPixa:

  1. Fork the Repository:

    • Fork this repository to your GitHub account.

  2. Clone the Repository:

    • Clone your forked repository to your local development environment: 
      $ git clone https://github.com/thedatatribune/dyPixa.git
$ cd dyPixa

  3. Create a New Branch:

    • Create a new branch for your contribution. Choose a descriptive branch name: 
      $ git checkout -b feature-or-fix-name

  4. Make Changes:

    • Implement your contribution or fix the issue you're working on. Ensure your code follows the project's coding guidelines mentioned in Code of Conduct.

  5. Test Your Changes:

    • Test your changes thoroughly to ensure they work as intended.

  6. Commit Your Changes:

    • Commit your changes with a clear and concise commit message: 
      $ git commit -m "Your message here"

  7. Push to Your Fork:

    • Push your changes to your fork on GitHub: 
      $ git push origin feature-or-fix-name

  8. Create a Pull Request:

    • Go to the dyPixa repository on GitHub.
    • Click on "New Pull Request" and follow the prompts to create a pull request. Provide a clear title and description.

  9. Code Review:

    • Your pull request will be reviewed by project maintainers. Be prepared to address any feedback or make necessary changes.

  10. Merge:

    • Once your contribution is approved, it will be merged into the main branch.

Reporting Issues

If you encounter a bug, have a feature request, or have questions about the project, please open an issue on the GitHub repository.

Development Guidelines

  • Follow the project's coding style and conventions.
  • Write clear and concise commit messages.
  • Keep pull requests focused on a single issue or feature. If you cannot locate a suitable issue, feel free to create a new one.
  • Be respectful and constructive in discussions and comments.

Licensing

By contributing to dyPixa, you agree that your contributions will be licensed under the project's MIT License.

Thank you for your contributions and support in making dyPixa a great open-source project!