Skip to content

Latest commit

 

History

History
81 lines (52 loc) · 3.39 KB

contributors.md

File metadata and controls

81 lines (52 loc) · 3.39 KB

Contributor Guidelines for python-nocodb

Welcome to python-nocodb! We're excited that you want to contribute to our open-source project. Please take a moment to read and follow these guidelines to ensure a smooth and collaborative development process.

Table of Contents

Contribution Process

To contribute to this project, follow these steps:

1. Fork the Repository

Click the "Fork" button on the top right corner of the repository's page on GitHub. This will create a copy of the repository in your GitHub account.

2. Create a Branch

Clone your forked repository to your local machine, then create a new branch for your contribution. Name your branch in a descriptive manner that reflects the purpose of your contribution.

git clone https://github.com/your-username/python-nocodb.git
cd python-nocodb
git checkout -b feature/your-feature

3. Work on Your Contribution

Now you can start working on your contribution. Be sure to follow the coding guidelines (mentioned below) and implement your changes or new features.

4. Test Your Code

Thoroughly test your code to ensure it works as expected. Make sure to write unit tests, if applicable. Your contribution should not introduce new bugs or regressions.

5. Commit Your Changes

Once you are satisfied with your work, commit your changes. Be sure to write clear and descriptive commit messages.

git add .
git commit -m "Add a clear and concise commit message"

6. Create a Pull Request

When your code is ready for review, push your changes to your forked repository, and then open a Pull Request (PR) to the main repository's main branch. In your PR description, provide a clear and detailed explanation of your contribution, including what the change does and why it is needed.

Our team will review your PR, provide feedback, and merge it when it meets our quality and functionality standards.

Coding Guidelines

Please adhere to the following coding guidelines:

  • Follow the style and conventions used in the existing codebase.
  • Write clean, readable, and well-documented code.
  • Keep code modular and DRY (Don't Repeat Yourself).
  • Ensure your code is consistent with the project's coding standards.
  • Include unit tests when adding new functionality.

Documentation

Documentation is crucial for maintaining and improving our project. When you make a contribution, you should:

  • Update or add documentation to explain the new capabilities or changes you've made.
  • Include comments within your code to explain complex logic or important decisions.
  • If you add or change a feature, update the project's README to reflect these changes.

Authors

We appreciate all contributors to our project. To give credit where it's due, please add your name and GitHub username to the "Authors" section of the README if it's not already there.

Thank you for your interest in contributing to python-nocodb. We look forward to your contributions and collaborations. Happy coding!