Skip to content

Latest commit

 

History

History
71 lines (51 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

71 lines (51 loc) · 2.23 KB

Contributing to [MLSA Chapter Name] Website

First off, thank you for taking the time to contribute! We appreciate your efforts and value every contribution.

Table of Contents

  1. How to Contribute
  2. Code of Conduct
  3. Getting Started
  4. Pull Request Process
  5. Style Guide
  6. Issues
  7. Contact

How to Contribute

We welcome contributions in the following areas:

  • Bug fixes
  • New features
  • Documentation improvements
  • Code refactoring
  • Style and design enhancements

If you are unsure of what to contribute, check out the open issues for ideas!

Code of Conduct

Please read our Code of Conduct to understand the expectations for interactions and contributions within our community.

Getting Started

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine. 
    git clone https://github.com/your-username/mlsa-chapter-website.git
  3. Create a new branch for your changes.
    git checkout -b your-feature-branch
  1. Make your changes and commit them
    git commit -m "Description of the changes made"
  1. Push your changes to your forked repository: 
       git push origin your-feature-branch

Pull Request Process

  1. Ensure your code adheres to the project’s style guide.
  2. Make sure all tests pass (if applicable).
  3. Submit your pull request to the main branch.
  4. Add a clear and descriptive title and description to your pull request.
  5. Wait for a project maintainer to review and merge your PR.

Style Guide

  • Follow Prettier for code formatting.
  • Use ESLint to check for JavaScript code quality.
  • Write meaningful commit messages in the format: type(scope): description.

Issues

If you encounter a problem or have a suggestion, please open an issue describing the problem or idea.

Contact

For any questions or further discussion, feel free to reach out to the maintainers.