Skip to content

Latest commit

 

History

History
108 lines (75 loc) · 3.03 KB

CONTRIBUTIONS.md

File metadata and controls

108 lines (75 loc) · 3.03 KB

Contributions Guide

Thank you for your interest in contributing to the Molecule Visualiser project! This guide will help you understand how to contribute effectively.

Table of Contents

  1. Getting Started
  2. How to Contribute
  3. Code of Conduct
  4. Reporting Issues
  5. Creating Pull Requests
  6. Style Guide

Getting Started

To contribute:

  1. Fork the repository from Molecule Visualiser and clone it to your local machine: 
    git clone https://github.com/YourUsername/Molecule-Visualiser.git

Set Up the Project

  • Follow the instructions in the README.md to set up the project.
  • Ensure your environment matches the project requirements.

How to Contribute

Issues

  • Check the Issues section for open tickets.
  • If you want to work on an existing issue, comment on the issue to let others know you're working on it.
  • If you find a bug or have a feature request, create a new issue.

Feature Requests

  • Before starting work on a new feature:
    • Discuss the feature in an existing issue or create a new one.
    • Ensure it aligns with the project's goals.

Code of Conduct

This project follows the Contributor Covenant.
All contributors must adhere to it. Be respectful and constructive in all interactions.

Reporting Issues

When reporting an issue:

  • Provide a clear and descriptive title.
  • Include steps to reproduce the issue.
  • Share relevant logs or screenshots if applicable.
  • Specify the environment (e.g., operating system, browser, Node.js version).

Creating Pull Requests

Follow these steps to create a pull request:

  1. Create a new branch from main or the relevant base branch: 
    git checkout -b feature/your-feature-name

    Make Your Changes

  • Ensure code quality and thorough testing.

Commit Your Changes

git commit -m "Add a concise and descriptive commit message"

Push the Branch to Your Fork

git push origin feature/your-feature-name

Open a Pull Request (PR)

  • Open a pull request (PR) to the main branch of the original repository.

PR Guidelines

  • Provide a detailed description of the changes in the PR.
  • Reference related issues (e.g., Closes #123).
  • Ensure the PR passes all checks (tests, linters).

Style Guide

Code

  • Follow the style conventions mentioned in the project documentation (e.g., ESLint rules for JavaScript).
  • Write clear, concise, and well-documented code.

Commits

  • Use descriptive commit messages (e.g., Fix bug in molecule visualization logic).
  • Group related changes into a single commit.

Acknowledgments

Thank you for taking the time to contribute! Your efforts make this project better for everyone.