Skip to content

Latest commit

 

History

History
93 lines (54 loc) · 3.48 KB

CONTRIBUTING.md

File metadata and controls

93 lines (54 loc) · 3.48 KB
Raw

Contributing to devlinks

Thank you for considering contributing to devlinks! Whether you're fixing bugs, adding new features, or improving documentation, your efforts are greatly appreciated. Please take a moment to review the guidelines below before getting started.

Table of Contents

How to Report Issues

If you encounter any bugs, have suggestions, or see something that doesn’t look right, please report it by opening an issue in the GitHub repository. When creating an issue, please include:

  • A clear and descriptive title.
  • Detailed information about the problem, including steps to reproduce it, if applicable.
  • Any relevant screenshots or logs.
  • Your environment details (e.g., operating system, browser, etc.).

How to Submit a Pull Request

1. Fork the Repository

Click the "Fork" button at the top right of this repository to create a copy in your GitHub account.

2. Create a Branch

Create a new branch in your forked repository for your feature or bugfix:

git checkout -b your-branch-name

3. Make Your Changes

  • Implement your changes, making sure to adhere to the Code Standards outlined below.

4. Test Your Changes

  • If applicable, thoroughly test your changes to ensure they work as expected and do not introduce new issues.

5. Submit a Pull Request

  • Once your changes are ready, push your branch to your forked repository:
git push origin your-branch-name
  • Go to the original repository and submit a pull request from your branch. Include a clear description of your changes and reference any related issues.

6. Code Review

  • Your pull request will be reviewed by the maintainers. Feedback may be provided, and changes might be requested before your contribution is merged.

Code Standards

To ensure consistency and quality across the project, please follow these coding standards:

  • Naming Conventions: Use descriptive and consistent names for variables, functions, and files.

  • Code Formatting: Follow the established code formatting guidelines (e.g., indentations, spacing).

  • Comments: Include comments where necessary to explain complex logic or code that might not be immediately clear.

  • Commit Messages: Write clear, concise commit messages that describe your changes.

Feature Requests

If you have an idea for a new feature that would improve devlinks, we’d love to hear it! Please open an issue with a "Feature Request" label and provide:

  • A detailed description of the feature.
  • The problem it solves or the improvement it brings.
  • Any mockups or examples if applicable.

Improving Documentation

Good documentation is key to a successful project. If you see an area where the documentation can be improved, feel free to contribute. This could include:

  • Clarifying existing documentation.

  • Adding new sections or examples.

  • Updating documentation to reflect recent changes.

Community and Support

We strive to make devlinks a welcoming and inclusive community. Please adhere to the project's Code of Conduct and treat everyone with respect.

If you have any questions or need help getting started, feel free to reach out via GitHub Issues or devlinks.fun@gmail.com.