Skip to content

Latest commit

 

History

History
87 lines (64 loc) · 3.29 KB

CONTRIBUTING.md

File metadata and controls

87 lines (64 loc) · 3.29 KB
Raw

Introduction

Welcome

First off, thank you for considering contributing to this repo.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

This website is an open source project and we welcome any contributions from our community! There are more ways to contribute that just fixing bugs and writing features - improving the design, submitting bug reports and opening issues are all great contributions and will be welcomed as much as any other.

Ground Rules

As contributors you should be respectful and considerate of others - both contributors and non-contributors alike. Please refer to the code of conduct for our and your responsibilities to the rest of the community.

Your Responsibilities

  • Ensure contributions are unit tested and that all tests pass before submitting any pull-request
  • If you do find any issues or think of a feature please create a Github issue for this first. Discuss things transparently and get community feedback.

Quick Start

1. Fork this repository

2. Clone the fork to your local machine

git clone https://github.com/username/cea.ac.in .

3. Switch to the directory and install all packages

npm install

4. Start Development Environment

npm start

This will provide you with a web interface available at http://localhost:8080/

Your First Contribution

If you're not sure where to start issues we've labelled some issues with #for-new-contributors so these are a great place to start!

If you do decide to work on an issue comment saying you intend to pick it up and we'll assign it to you. If you decide it's too much however do tell us and we can try to help out or unassign it so it's free for someone else to pick up.

New to contributing to open-source?

Working on your first Pull Request? You can learn how from this free series, How to Contribute to an Open Source Project on GitHub.

At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first 😸

Loading

  • Add your html files in the src directory (By default index.html is added to your src directory, feel free to make changes)

    • Make sure you add it in your webpack.config.js (Replace yourfile with your filename)

      plugins: [
    ...
    new HtmlWebpackPlugin({
        template: 'src/yourfile.html',
        inject: 'body',
        filename: 'yourfile.html'
    }),
    ...
],

  • Add images to your src/assets folder

  • Add sass files to src/scss folder

    • Make sure you import the scss file in main.scss

      @import "filename";

Note

After modifying 'webpack.config.js' file, make sure you install the currently required modules with

npm install

Then start development environment normally with

npm start