Skip to main content

Contribution Guidelines

Thank you for your interest in contributing to the DayKeeper API! We appreciate your support and are excited to work with you to make our project even better. Please follow these guidelines to ensure a smooth contribution process.

How to Contribute​

1. Fork the Repository​

Start by forking the repository on GitHub. This will create a personal copy of the project where you can make changes without affecting the original codebase.

2. Clone Your Fork​

Clone your forked repository to your local machine using:

git clone https://github.com/your-username/daykeeper-api.git

3. Create a New Branch​

Before making any changes, create a new branch for your work. Use a descriptive name for the branch that reflects the nature of your contribution:

git checkout -b your-branch-name

4. Make Your Changes​

Implement your changes or new features. Please adhere to the following best practices:

  • Follow Coding Standards: Ensure your code follows the project's coding standards and style guides.
  • Maintain Backward Compatibility: Ensure that your changes do not break existing functionality or APIs. Test thoroughly.
  • Be Clear and Concise: Write clean, readable code with appropriate comments and documentation.

5. Write Tests​

If your changes include new features or bug fixes, write tests to verify that they work as expected. Ensure that:

  • All Existing Tests Pass: Run all existing tests to ensure your changes do not introduce new issues.
  • New Tests Cover Changes: Add tests that cover the new functionality or bug fixes you have implemented.

6. Update Documentation​

Update the documentation to reflect any changes made to the API or project. This includes:

  • README Files: Update the main README and any relevant documentation files.
  • API Documentation: Ensure that API endpoints and their usage are accurately described.
  • Inline Code Comments: Provide clear comments within the code to explain complex logic or decisions.

7. Commit Your Changes​

Commit your changes with a clear and descriptive message. Follow these guidelines:

  • Write Descriptive Messages: Use a concise and descriptive commit message to explain the purpose of the changes.
  • Format Commits: Ensure your commits are well-formatted and include relevant details.
git add .
git commit -m "Add a clear and concise description of your changes"

8. Push Your Changes​

Push your changes to your forked repository:

git push origin your-branch-name

9. Open a Pull Request​

Navigate to the original repository and open a pull request. Provide a detailed description of your changes and reference any related issues.

10. Participate in Code Review​

Be responsive to feedback from the project maintainers. Address any requested changes and updates promptly. Ensure that:

  • Code Review Feedback: Incorporate feedback to improve the quality and functionality of your contribution.
  • Clarify Issues: Provide clear explanations if questions or concerns arise during the review process.

Code of Conduct​

We expect all contributors to adhere to our Code of Conduct. Please be respectful and professional in all interactions.

Reporting Issues​

If you encounter any issues or bugs, please create an issue on GitHub. Provide as much detail as possible, including:

  • Steps to Reproduce: Describe the steps to replicate the issue.
  • Error Messages: Include any error messages or stack traces.

Getting Help​

If you need assistance or have questions about contributing, feel free to reach out to us via email or join the discussion in our community forums.

Thank you for contributing to the DayKeeper API! Your efforts help us build a better product for everyone.

Feel free to modify the links and details according to your project's specifics.