Hey, thanks for taking your time to help out Sustainable Urban Design 👍
The following is a set of guidelines for contributing to Sustainable Urban Design. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to any document in a pull request.
What should I know before getting started?
This project and everyone participating are all governed by the Code of Conduct dun dun dun. By participating, you are expected to uphold this code. Please report any unacceptable behavior to Max Thakur, or Brylie Christopher Oxley
Note: please check the FAQ to see if your question has already been asked
Please go about making your questiong as an issue, but at the beginning please put [Question].
If this isn't your type of way then you can either email maxthakurcode@gmail.com, or add Max Thakur on Discord Max Thakur#0831
Here at Sustainable Urban Design, our goal is to make a 100% open-source service that is free forever for anyone to use at their discretion.
This section guides you through how to make bug reports for Sustainable Urban Design. Following these guidelines will streamline the process for the community to understand, reproduce, and create a fix for the bug you found.
Before creating a bug report, please check all the sources below to see if it has already been reported.
- Check already opened and closed bug reports, to see if anyone has had the same or close bug to your's. If someone has and it's closed add a #(issue number here) to your issue in the body.
Bugs are tracked as issues. Create an issue using this template, filling in as much as possible.
Note: If you don't know or have an idea about how to fix the bug then just leave that part out of the report.
Make sure you include in the report:
- A descriptive title with
[Bug]at the beginning of it. - Everything required by the template.
Note: Please be ready to provide more information upon request of any user.
This section guides you through how to make suggest new idea for Sustainable Urban Design. Following these guidelines will streamline the process for the community to understand, and make your idea a feature.
- Check already created suggestions, to see if anyone has had the same idea as you.
Ideas are tracked as issues. Create an issue using this template
Make sure you include in the suggestion:
- A descriptive title with
[enhancement]at the beginning of it. - Everything required by the template.
Unsure where to start contributing to Sustainable Urban Design?
- Look at the label
good first issuefor good first issues. - Also check
Help wanted issuesfor a little more complex issues
This section guides you through how to make Pull Requests for Sustainable Urban Design. Following these guidelines will streamline the process for the community to understand, review, and discuss your requested changes.
Please follow these steps to have your contribution considered by the maintainers:
- Follow all the instructions in the template
- After you submit your pull request, verify that all status checks have a :check: next to them.
Note: The reviewer(s) of your Pull Request might request changes before they approve your pull request to be merged or rebased.
| Label Name | GitHub | Description |
|---|---|---|
| bug | search | Confirmed bugs or reports that are very likely to be bugs. |
| enhancement | search | New feature or request |
| question | search | Further information is requested |
| help wanted | search | The core team would love help from the community |
| duplicate | search | This issue or pull request already exists, or has already been patched |
| good first issue | search | Good for newcomers |
| Needs Follow Up | search | Needs more detail later. |
| Won't fix | search | The team has decided this will not be worked on |
| More Information Needed | search | More information needs to be collected about these problems or feature requests |
| Categories | GitHub | Description |
|---|---|---|
| documentation | search | Improvements or additions to documentation |
| security | search | A group of issues that can affect the security of the project |
| Label name | GitHub | Description |
|---|---|---|
| Work In Progress | search | Pull requests which are still being worked on, more changes will follow. |
| Needs Review | search | Pull requests which need code review, and approval from maintainers or Atom core team. |
| Requires Changes | search | Pull requests which need to be updated based on review comments and then reviewed again. |
| Needs Further Testing | search | Pull requests which need manual testing. |