Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
90 lines (67 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

90 lines (67 loc) · 2.78 KB

Here’s a set of Contribution Guidelines tailored for your open-source project:

Contribution Guidelines

Thank you for considering contributing to Blok! We welcome contributions of all types, including bug fixes, feature implementations, documentation improvements, and feedback. These guidelines are here to make the process clear and smooth for everyone.

How to Contribute

1. Discuss Your Idea

  • Before starting work on a major change, please open an issue in the repository.
  • Use the #ideas-and-feedback channel in our Discord community for discussions.

2. Fork and Clone

  • Fork the repository to your GitHub account.
  • Clone the forked repository to your local machine.
git clone https://github.com/YOUR_USERNAME/blok.git
cd blok

3. Set Up Your Environment

  • Follow the instructions in the README.md to set up your development environment.
  • Run tests to ensure everything works as expected.

4. Work on Your Contribution

  • Create a new branch for your work: 
    git checkout -b feature/your-feature-name
  • Follow the coding style and conventions used in the project.
  • Write clear, concise, and well-documented code.
  • If adding a new feature, include relevant tests.

5. Commit Your Changes

  • Write meaningful commit messages: 
    git commit -m "Add: Feature description"
  • Push your changes to your fork: 
    git push origin feature/your-feature-name

6. Submit a Pull Request

  • Open a pull request from your branch to the main branch of the original repository.
  • Use the pull request template (if available) to provide details about your changes.
  • Ensure that all automated tests pass before submission.

Code Style and Standards

  • Use ESLint to ensure code consistency.
  • Adhere to the project's architectural patterns and modular design principles.
  • Avoid introducing unnecessary dependencies.

Reporting Issues

If you encounter a bug or have a feature request:

  1. Check the Issues to ensure it hasn’t been reported.
  2. Open a new issue with:
    • A clear and descriptive title.
    • Steps to reproduce the issue (if applicable).
    • Expected and actual behavior.

Documentation Contributions

  • For documentation edits, update the relevant markdown files in the docs/ directory.
  • Follow a clear and concise writing style.

Community and Conduct

  • Be respectful and collaborative when interacting with others.
  • Adhere to the project's Code of Conduct.

Need Help?

If you have questions or need help, feel free to:

We’re excited to collaborate with you and improve Blok together!