Skip to content

Latest commit

 

History

History
84 lines (65 loc) · 2.95 KB

CONTRIBUTIONS.md

File metadata and controls

84 lines (65 loc) · 2.95 KB
Raw

Here's a sample Contributing Guidelines section for your package's README:

Contributing to CARTE

Thank you for considering contributing to the CARTE project! We welcome contributions that help improve the functionality, reliability, and documentation of CARTE. Please follow these guidelines to make your contributions seamless and productive.

How to Contribute

1. Reporting Issues

If you find a bug, have a feature request, or want to suggest improvements, please open an issue. When reporting issues, please include:

  • A descriptive title
  • Detailed steps to reproduce the issue
  • The expected outcome versus the actual outcome
  • Any relevant code snippets, logs, or screenshots

2. Code Contributions

We appreciate any form of code contribution, whether it be bug fixes, new features, or enhancements. Follow these steps to contribute code:

Step 1: Fork the Repository

Fork the CARTE repository to your GitHub account and clone it locally:

git clone https://github.com/your-username/carte.git
cd carte

Step 2: Create a Branch

Create a new branch specific to your contribution:

git checkout -b feature/your-feature-name

Step 3: Implement Changes

Make your code changes. Be sure to:

  • Follow the existing code style.
  • Include comprehensive comments and documentation for new code.
  • Write or update relevant tests.

Step 4: Run Tests

Ensure all existing and new tests pass:

# Run unit tests
pytest

# Run any additional test suites
# Add other relevant test commands as needed

Step 5: Commit Changes

Commit your changes with a descriptive message:

git add .
git commit -m "Add/Update [feature/fix]: [description of changes]"

Step 6: Push Changes

Push your branch to your forked repository:

git push origin feature/your-feature-name

Step 7: Create a Pull Request

Create a pull request (PR) to the main branch of the CARTE repository. Be sure to:

  • Describe the purpose of the PR and reference any related issues.
  • Highlight any important points that reviewers should know.

Code Style and Standards

  • Follow PEP 8 for Python code.
  • Use descriptive variable and function names.
  • Maintain consistent indentation and formatting throughout the code.
  • Ensure docstrings and comments are clear and informative.

Documentation Contributions

We value well-documented code and user-friendly documentation. To contribute to documentation:

  • Update or add relevant sections in the Markdown files under the docs/ folder.
  • Ensure your documentation is clear, concise, and consistent with the project's style.

Community and Collaboration

  • Join discussions in the issue tracker or PR comments.
  • Be respectful and constructive in all communications.

License

By contributing, you agree that your contributions will be licensed under the MIT License.