We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great. Contributions to this project are released to the public under the project's open source license. Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
This document explains how to set up the project locally, submit issues, and create pull requests for seamless collaboration.
Before you begin you must:
- Install Hugo, to build the site locally.
To run the project locally and see changes in action:
- Navigate to your local project folder
cd bsidesgrunn.org - Run the Hugo development server
hugo server
This will start a local server, available at http://localhost:1313/ by default, where you can preview your changes in the browser.
After making changes, please check the following:
- Visual Issues: Ensure that the site layout, design, and content display as expected.
- Navigation: Test if all buttons and navigation tabs work as expected.
- Responsiveness: Check the layout on different screen sizes (you can resize your browser window or use developer tools to simulate mobile views).
- Fork and clone the repository.
- Create a new branch:
git checkout -b my-branch-name. - Make your change, add tests, and make sure the tests still pass.
- Push to your fork and submit a pull request.
- Pat your self on the back and wait for your pull request to be reviewed and merged.
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
- Follow standards for style and code quality.
- Write tests.
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
- Write a good commit message.