The following workflow describes the minimal steps required to contribute content for a new subject:
Think about a subject that is of interest to Software Engineers and from your own experience is not covered well by existing tutorials or is not easily accessible.
Explore the detailed Table of Contents (TOC) to get ideas of such subjects and identify where your contribution may fit. If you think that the current TOC requires changes, we recommend that you open an issue that presents your change or fix.
Goto the handbook repository on GitHub and use the 'Create new file' button to start editing the content online. When finished, optionally add description using the 'Propose new file' dialog, and finally submit the file using the 'Propose new file' button.
Note: Since you are creating a file in a project you don’t have write access to. Submitting a change will create the file in a new branch in your fork, so you can send a pull request. Visit Contributing to an Open Source Project for more details on fork and pull request.
Learn about the differences between Guides and Topics in the context of the Software Engineering Handbook.
Create Guides and/or Topics for the selected subject as described above. Include appropriate references to external sources with minimal duplications of exiting materials. Create internal links associating between the Guides and Topics documents for the subject.
- Use Markdown.
- See relevant examples in Guides and Topics directories.
- Use preview tools for Markdown (e.g., GitHub itself for files ending with
.md).
We use GitHub Flow, which means all changes happen through pull requests.
If you are a first time contributor, we recommend that you open an issue that presents your change or fix, before submitting a pull request.