# How to Participate
Development of the Open DC Grid Standard and the associated reference implementations is a collaborative effort driven by volunteers. We welcome anyone to offer ideas and technical contributions.
We welcome every sort of contribution, from error reports to improvements of the document or entirely new ideas or chapters.
# Contact us
You can contact us by email: email@example.com
# Subscribe to our newsletter
The project publishes a periodic newsletter about the latest developments. We promise not to spam you with too much news. You can subscribe here (opens new window). You can also browse the full archive (opens new window) of past newsletters. Thanks to Buttondown (opens new window) for our mailing service.
# Attend a meeting
The project holds monthly web-based teleconferences using the conferencing service freeconferencecall.com (opens new window) to discuss the status and present new ideas. A login to the service is not required but downloading their free app can give you a better experience. We record the meetings so people can review them later and provide a link to any materials presented. Meeting details are available on the Meetings page of this web site.
# Visit us on GitHub
All project materials are publically accessible on the software development platform GitHub (opens new window) as a collection of repositories under the Git (opens new window) source control system for the organization open-dc-grid (opens new window). A GitHub login is not required to view or download the materials but is required if you wish to propose new material or changes to existing materials. GitHub logins are free.
Open DC Grid materials are located in one of the following repositories:
- standard (opens new window): the text of the Open DC Grid Standard
- implementation (opens new window): reference designs and implementation suggestions
- open-dc-grid.github.io (opens new window): this web site and project administration
# Offering suggestions or concerns
If you would like to contribute directly to the project, please follow the GitHub workflow described below to modify the affected document and submit a pull request to the team. If you just want to offer a suggestion or raise a concern, navigate to the appropriate repository: standard (opens new window), implementation (opens new window) or project / web site (opens new window) and click on the issues tab on the page as shown in the following screen shot:
This will take you to an issues page with a New Issue button where you can describe your concern. Submitting an issue notifies the team and one of us will respond to your concern.
# GitHub workflow
With GitHub as the backend, the development of this specification applies well-established collaboration workflows as used in software development.
If you are not yet familiar with the git-based collaboration, the easiest way is probably to use the GitHub web interface:
- Fork the repository to your personal GitHub account.
- Create a new branch in your account named after what you want to change.
- Modify or add files and commit the changes.
- Submit a pull request via the GitHub web interface and wait for the response of other contributors or reviewers.
Small changes can be made using the editor on the GitHub web site from within your browser so you don't need to install any tools on your PC. For more complex changes it can be convenient to clone a repository to copy all the source files to your local PC. You then create a branch, make your changes and push the branch back to your own fork on GitHub. When you are satisfied with your changes, submit a pull request to the Open DC Grid team.
Note that Git is supported by many of the popular integrated development environments such as Windows Visual Studio (opens new window) (including the free Community Edition (opens new window), Apple XCode (opens new window), Eclipse (opens new window) and others. The GitHub site offers a GUI tool GitHub Desktop (opens new window) that can be installed on Windows, Mac or Linux. Using an IDE can be easier for people unused to command line tools but many developers prefer to use Git directly from the command line with their favorite text editor. The free editor Atom (opens new window) and others include tools to view the formatted version of markdown files which can be helpful to see the formatted version of your text.
# Important remarks:
- Better make several small atomic commits (opens new window) than a single big one
- Use meaningful commit messages. Tell what was changed and not that something was changed. "Grid stability: Voltage graph added" is much better than "Updates". You can also reference an issue with its numer (e.g. #123) in the commit message
This page is developed using VuePress. The content is written in the easy to learn markdown syntax. The link at the bottom of each page guides you to the correct file for modifications.
See the VuePress documentation (opens new window) for more details.