Skip to content

Latest commit

History

History
31 lines (21 loc) 路 1.47 KB

CONTRIBUTING.md

File metadata and controls

31 lines (21 loc) 路 1.47 KB

Contributing to Analytiks

Thank you for considering contributing to Analytiks! We welcome all contributions from the community, whether they are code contributions, bug reports, feature requests, or anything else.

How to contribute

Here are the steps to follow to contribute to Analytiks:

  1. Fork the repository and clone it to your local machine.
  2. Create a new branch for your changes: git checkout -b my-branch
  3. Make your changes and commit them with a descriptive commit message: git commit -m "Add new feature"
  4. Push your changes to your forked repository: git push fork my-branch
  5. Create a pull request from your forked repository to the main repository.
  6. Wait for review and feedback from maintainers and other contributors.
  7. If your pull request is approved, your changes will be merged into the main repository.

Code guidelines

Please follow these guidelines when writing code for Analytiks:

  1. Be consistent with the existing code.
  2. Write clear code & self-explaining code.
  3. Boy-scout rule: Always leave the code better than you found it.
  4. Write tests for new features or bug fixes, if needed.
  5. Keep the code modular and well-organized.

Bug reports and feature requests

If you find a bug or have a feature request, please create an issue in the issue tracker. Be sure to include a detailed description of the problem or feature, along with any relevant information that can help us reproduce or understand the issue.

Thank you for your contributions!