Thank you for considering contributing to the sciDX API project! This document outlines the guidelines for contributing to the project.
If you find a bug in the project, please open an issue on GitHub and provide the following information:
- A clear and descriptive title for the issue.
- A description of the steps to reproduce the issue.
- Any relevant error messages or screenshots.
- Your environment details (e.g., operating system, Python version, etc.).
Refer to the Guide to Creating Effective GitHub Issues for more information.
If you have an idea for a new feature or an improvement to an existing feature, please open an issue on GitHub and provide the following information:
- A clear and descriptive title for the enhancement.
- A detailed description of the proposed enhancement.
- Any relevant use cases or examples.
If you want to contribute code to the project, please follow these steps:
-
Fork the repository: Click the "Fork" button on the GitHub page to create a copy of the repository on your account.
-
Clone the repository: Clone your forked repository to your local machine.
git clone https://github.com/your-username/scidx-api.git- Create a new branch: Create a new branch for your feature or bugfix. Refer to the Standard Branch Naming Convention for more information on naming branches.
git checkout -b [type]/[descriptive-name]-
Make your changes: Make your changes to the codebase. Ensure that you follow the project's coding standards and include relevant tests.
-
Commit your changes: Commit your changes with a clear and descriptive commit message. Refer to the Effective Commit Messages Guide for more information on writing good commit messages.
git commit -m "Description of the changes made"- Push your changes: Push your changes to your forked repository.
git push origin [type]/[descriptive-name]- Create a pull request: Open a pull request on the original repository. Provide a clear and descriptive title for the pull request and include any relevant information about the changes you made.
- Follow PEP 8 for Python code.
- Write clear and concise code with appropriate comments.
- Ensure that your code is well-tested and that all tests pass before submitting a pull request.
By participating in this project, you agree to abide by the project's Code of Conduct.
If you need help or have any questions, feel free to open an issue on GitHub or reach out to the maintainers.