Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
84 lines (49 loc) · 2.73 KB

CONTRIBUTING.md

File metadata and controls

84 lines (49 loc) · 2.73 KB

Contributing to Farpy

Thank you for considering contributing to Farpy! We welcome contributions from developers of all backgrounds and experience levels. Whether you’re fixing bugs, improving documentation, or adding new features, your help is greatly appreciated.

How to Contribute

To ensure a smooth contribution process, please follow these steps:

1. Fork the Repository

Fork the repository to your GitHub account by clicking the "Fork" button at the top-right of the repository page.

2. Clone Your Fork

Clone the forked repository to your local machine:

git clone https://github.com/<you-username>/farpy.git
cd farpy

3. Create a New Branch

Create a new branch to work on your feature or bugfix. It's good practice to name your branch descriptively:

git checkout -b <your-feature-or-fix-name>

4. Make Your Changes

Work on your feature or bugfix. Make sure your changes align with the existing code style and architecture. If you’re adding a new feature, consider adding appropriate tests.

5. Commit Your Changes

Once you're happy with your changes, commit them with clear, descriptive messages:

git add .
git commit -m "Descriptive commit message"

6. Push Your Changes

Push your changes to your forked repository:

git push origin <your-feature-or-fix-name>

7. Open a Pull Request

Open a pull request (PR) from your branch to the main branch of the main Farpy repository. In your PR description, explain what your changes do and why they’re needed.

Code Style

Please follow the coding style used in the project. Here are a few guidelines:

  • Use 2 spaces for indentation (no tabs).
  • Write clear and descriptive commit messages.
  • Keep your code simple, clean, and well-commented.
  • Avoid large, monolithic commits. Break your work into logical chunks.

Testing

Before submitting your pull request, please run tests to ensure that your changes do not break existing functionality.

If you're adding new functionality, ensure that you add appropriate tests for it. For the compiler, we encourage writing tests that check for correctness and performance.

Reporting Issues

If you find a bug or have a feature request, please feel free to open an issue in the Issues section. Be sure to provide as much detail as possible, including steps to reproduce the issue, expected behavior, and any relevant error messages.

Thank You

We greatly appreciate your interest in contributing to Farpy! If you have any questions, feel free to reach out by opening an issue or contacting the project maintainers directly.