Skip to content

Latest commit

 

History

History
78 lines (53 loc) · 4.08 KB

CONTRIBUTING.md

File metadata and controls

78 lines (53 loc) · 4.08 KB

Contributing to TrajAllocPy

Thank you for considering contributing to TrajAllocPy! We appreciate your interest in helping us improve our project. Please take a moment to review this guide to understand how you can contribute.

Table of Contents

Code of Conduct

This project and everyone participating in it are governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report any unacceptable behavior to [project email].

Ways to Contribute

There are many ways to contribute to TrajAllocPy:

  1. Bug Reports: If you find a bug, please open an issue on our GitHub repository.
  2. Feature Requests: You can request new features by opening an issue on GitHub.
  3. Documentation: Help improve the project's documentation by submitting changes or providing feedback.
  4. Code Contributions: You can contribute to the project by forking the repository, creating a branch, and submitting a pull request.
  5. Helping Users: You can answer questions or solve issues for other users on our issue tracker.

Getting Started

To get started with contributing, follow these steps:

  1. Fork the repository: Click the "Fork" button on the top right of the repository's page.
  2. Clone your fork: Use git clone to clone your forked repository to your local machine.
  3. Set up the project: Follow the instructions in the project's README for setting up the development environment.
  4. Create a new branch: Use git checkout -b feature/your-feature to create a new branch for your changes.
  5. Make your changes: Write your code and make your desired changes.
  6. Test your changes: Ensure your changes do not break existing functionality and follow the testing guidelines below.
  7. Commit your changes: Use git commit to commit your changes locally.
  8. Push your changes: Push your changes to your fork on GitHub using git push.
  9. Create a pull request: Open a pull request on the main repository.

Submitting Changes

When you're ready to submit your changes, please make sure to:

  1. Create a clear and descriptive pull request title.
  2. Provide a detailed description of the changes you've made.
  3. Reference any relevant issues by including "Closes #issue-number" in the description.
  4. Follow the code guidelines and testing procedures outlined in this guide.
  5. Be responsive to comments and feedback on your pull request.

Development Workflow

  • The main branch is the stable branch. It's best to create your branches from main.
  • We use GitHub Actions for continuous integration, so make sure your code passes the checks.
  • Squash your commits into a single meaningful commit before merging.

Code Guidelines

Please follow our code guidelines for writing clean and maintainable code. If you have questions, feel free to ask on the pull request or in the community.

Testing

Before submitting a pull request, ensure that you have tested your changes and that they don't introduce new issues. Write tests where applicable, and run existing tests to verify the integrity of the code.

Documentation

Documentation is crucial for understanding and maintaining the project. If your contribution involves changes to the documentation, please ensure that your updates are clear, concise, and accurate.

Community

Join our community! We welcome everyone, regardless of your level of expertise. If you have questions, need help, or want to discuss ideas, join our community chat or mailing list.

We appreciate your time and effort in contributing to TrajAllocPy. Your contributions make this project better for everyone.

Thank you for being a part of our open source community!