Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
100 lines (78 loc) · 4.22 KB

CONTRIBUTING.md

File metadata and controls

100 lines (78 loc) · 4.22 KB

Contribution Guidelines 🤝

Thank you for your interest in contributing to the Heaven's Labs website! We’re excited to have you help us improve our platform and further our mission. Before you start contributing, please take a moment to review these guidelines.

Table of Contents

How to Contribute 🛠️

Types of Contributions

You can contribute in several ways, including:

  • Bug Fixes: Identify and fix bugs in the website.
  • New Features: Develop and propose new features to enhance the website's functionality.
  • Content Creation: Write and improve website content, such as blog posts or project descriptions.
  • Design and UX: Improve the website's design, user experience, and accessibility.
  • Documentation: Update or create new documentation to help others understand and contribute to the project.

Fork, Branch, and Pull Request Workflow

  1. Fork the Repository: Create your own copy of the repository by clicking the "Fork" button at the top right of the project page.

  2. Create a Branch:

    • Use descriptive branch names for your work, such as fix-bug-issue123 or add-new-feature.
    • To create a new branch, run: 
      git checkout -b my-feature-branch

  3. Make Changes:

    • Ensure your changes follow the project’s coding standards and pass all tests.
    • Write clear and concise commit messages to document your work: 
      git commit -m "Fix issue with navigation bar responsiveness"

  4. Push to Your Fork:

    • After committing your changes, push them to your fork: 
      git push origin my-feature-branch

  5. Submit a Pull Request:

    • Go to the original repository on GitHub and click on "New Pull Request."
    • Ensure that your pull request (PR) clearly describes the changes you’ve made and references any related issues.

Code of Conduct 📜

We follow a Code of Conduct that outlines our expectations for participants in our community. Please read it before contributing to ensure a welcoming and positive environment for everyone.

Getting Started 🚀

  1. Clone the Repository:

    git clone https://github.com/heavenslabs/website.git
cd website

  2. Install Dependencies:

    • Make sure you have Node.js installed, then run: 
      npm install

  3. Start the Development Server:

    npm run dev
    • This will start a local server at http://localhost:3000 where you can view your changes.

  4. Run Tests:

    • If the project includes tests, run them to ensure your changes don’t break existing functionality: 
      npm test

Submitting a Contribution 📝

  • Pull Request Reviews: Your pull request will be reviewed by one of our maintainers. They may ask you to make additional changes before it can be merged.
  • Merging: Once your pull request is approved, a maintainer will merge it into the main branch. You may be asked to update your branch with the latest changes from the main branch before merging.

Style Guide 🎨

  • Code Style: Follow the existing coding style. Use consistent indentation, naming conventions, and formatting.
  • Commit Messages: Write clear, concise commit messages. Use the present tense ("Add feature" not "Added feature") and capitalize the first letter of the message.
  • Comments: Comment your code where necessary, especially for complex logic.

Reporting Issues 🐛

If you encounter a bug or have a feature request, please open an issue on GitHub. Provide as much detail as possible, including steps to reproduce the issue, screenshots, and any relevant code.

License 📄

By contributing to this project, you agree that your contributions will be licensed under the MIT License.

Thank you for contributing to Heaven's Labs! Together, we’re building something great.